goo/st-input.h

   1 /*
   2  * st-input.h
   3  *
   4  * Copyright (C) 2008 Vincent Geddes
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23 */
  24
  25 #ifndef __ST_INPUT_H__
  26 #define __ST_INPUT_H__
  27
  28 #include <st-types.h>
  29 #include <glib.h>
  30
  31 typedef struct STInput STInput;
  32
  33 enum
  34 {
  35     ST_INPUT_EOF = -1,
  36 };
  37
  38
  39 STInput   *st_input_new          (const char *string);
  40
  41 STInput   *st_input_new_ucs4     (const wchar_t *string);
  42
  43 wchar_t    st_input_look_ahead   (STInput *input, int i);
  44
  45 st_uint      st_input_get_line     (STInput *input);
  46
  47 st_uint      st_input_get_column   (STInput *input);
  48
  49 void       st_input_mark         (STInput *input);
  50
  51 void       st_input_rewind       (STInput *input);
  52
  53 void       st_input_seek         (STInput *input, st_uint index);
  54
  55 void       st_input_consume      (STInput *input);
  56
  57 st_uint      st_input_size         (STInput *input);
  58
  59 st_uint      st_input_index        (STInput *input);
  60
  61 char      *st_input_range        (STInput *input, st_uint start, st_uint end);
  62
  63 wchar_t   *st_input_range_ucs4   (STInput *input, st_uint start, st_uint end);
  64
  65 wchar_t   *st_input_next_chunk   (STInput *input);
  66
  67 void       st_input_destroy      (STInput *input);
  68
  69 #endif /* __ST_INPUT_H__ */