StreamFilter.h

00001 /**
00002  * =============================================================================
00003  * Stream filter for Twitter.
00004  * http://mbed.org/users/shintamainjp/notebook/starboard_expbrd-one_ex1_en/
00005  * =============================================================================
00006  * Copyright (c) 2010 Shinichiro Nakamura (CuBeatSystems)
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  *
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  * =============================================================================
00026  */
00027 
00028 #include "mbed.h"
00029 
00030 /**
00031  * Stream filter.
00032  */
00033 class StreamFilter {
00034 public:
00035 
00036     /**
00037      * Create.
00038      *
00039      * @param headtxt Head of a target.
00040      * @param tailtxt Tail of a target.
00041      */
00042     StreamFilter(const char *headtxt, const char *tailtxt);
00043 
00044     /**
00045      * Dispose.
00046      */
00047     ~StreamFilter();
00048 
00049     /**
00050      * Check state of done.
00051      *
00052      * @return Return true if it done.
00053      */
00054     bool done();
00055 
00056     /**
00057      * Reset state.
00058      */
00059     void reset();
00060 
00061     /**
00062      * Push a data to a internal buffer.
00063      *
00064      * @param c character.
00065      */
00066     void push(char c);
00067 
00068     /**
00069      * Get a content text.
00070      *
00071      * @param buf A pointer to a buffer.
00072      * @param bufsiz Size of the buffer.
00073      *
00074      * @return true if it succeed.
00075      */
00076     bool getContent(char *buf, size_t bufsiz);
00077 private:
00078     int headcnt;
00079     int tailcnt;
00080     const char * head;
00081     const char * tail;
00082     char content[1024];
00083 };