Main Page | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

cr-input.h

Go to the documentation of this file.
00001 /* -*- Mode: C; indent-tabs-mode:nil; c-basic-offset:8 -*- */
00002 
00003 /*
00004  * This file is part of The Croco Library
00005  *
00006  * Copyright (C) 2002-2003 Dodji Seketeli <dodji@seketeli.org>
00007  *
00008  * This program is free software; you can redistribute it and/or
00009  * modify it under the terms of version 2.1 of the GNU Lesser General Public
00010  * License as published by the Free Software Foundation.
00011  *
00012  * This program is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU Lesser General Public License
00018  * along with this program; if not, write to the Free Software
00019  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00020  * USA
00021  */
00022 
00023 
00024 /*
00025  *$Id: cr-input.h,v 1.3 2003/06/22 21:19:01 dodji Exp $
00026  */
00027 
00028 #ifndef __CR_INPUT_SRC_H__
00029 #define __CR_INPUT_SRC_H__
00030 
00031 
00032 #include <glib.h>
00033 #include "cr-utils.h"
00034 
00035 G_BEGIN_DECLS
00036 
00037 /**
00038  *@file
00039  *The libcroco basic input stream class
00040  *declaration file.
00041  */
00042 
00043 typedef struct _CRInput CRInput ;
00044 typedef struct _CRInputPriv CRInputPriv ;
00045 
00046 /**
00047  *The #CRInput class provides the abstraction of 
00048  *an utf8-encoded character stream.
00049  */
00050 struct _CRInput 
00051 {
00052         CRInputPriv *priv ;
00053 } ;
00054 
00055 typedef struct _CRInputPos CRInputPos ;
00056 
00057 struct _CRInputPos
00058 {
00059         glong line ;
00060         glong col ;
00061         gboolean end_of_file ;
00062         gboolean end_of_line ;
00063         glong next_byte_index ;
00064 } ;
00065 
00066 CRInput *
00067 cr_input_new_from_buf (const guchar *a_buf, gulong a_len,
00068                        enum CREncoding a_enc, gboolean a_free_buf) ;
00069 CRInput *
00070 cr_input_new_from_uri (const gchar *a_file_uri, enum CREncoding a_enc) ;
00071 
00072 void
00073 cr_input_destroy (CRInput *a_this) ;
00074 
00075 void 
00076 cr_input_ref (CRInput *a_this) ;
00077 
00078 gboolean
00079 cr_input_unref (CRInput *a_this) ;
00080 
00081 enum CRStatus
00082 cr_input_read_byte (CRInput *a_this, guchar *a_byte) ;
00083 
00084 enum CRStatus
00085 cr_input_read_char (CRInput *a_this, guint32 *a_char) ;
00086 
00087 enum CRStatus
00088 cr_input_consume_chars (CRInput *a_this, guint32 a_char, 
00089                         gulong *a_nb_char) ;
00090 
00091 enum CRStatus
00092 cr_input_consume_char (CRInput *a_this, guint32 a_char) ;
00093 
00094 enum CRStatus
00095 cr_input_consume_white_spaces (CRInput *a_this, gulong *a_nb_chars) ;
00096 
00097 enum CRStatus
00098 cr_input_peek_byte (CRInput *a_this, enum CRSeekPos a_origin,
00099                     gulong a_offset, guchar *a_byte) ;
00100 
00101 guchar 
00102 cr_input_peek_byte2 (CRInput *a_this, gulong a_offset, 
00103                      gboolean *a_eof) ;
00104 
00105 enum CRStatus
00106 cr_input_peek_char (CRInput *a_this, guint32 *a_char) ;
00107 
00108 guchar *
00109 cr_input_get_byte_addr (CRInput *a_this, 
00110                         gulong a_offset) ;
00111 
00112 enum CRStatus
00113 cr_input_get_cur_byte_addr (CRInput *a_this, guchar ** a_offset) ;
00114 
00115 enum CRStatus
00116 cr_input_seek_index (CRInput *a_this, 
00117                      enum CRSeekPos a_origin, gint a_pos) ;
00118 
00119 enum CRStatus
00120 cr_input_get_cur_index (CRInput *a_this, glong *a_index) ;
00121 
00122 enum CRStatus
00123 cr_input_set_cur_index (CRInput *a_this, glong a_index) ;
00124 
00125 enum CRStatus
00126 cr_input_get_cur_pos (CRInput *a_this, CRInputPos * a_pos) ;
00127         
00128 enum CRStatus
00129 cr_input_set_cur_pos (CRInput *a_this, CRInputPos *a_pos) ;
00130 
00131 enum CRStatus
00132 cr_input_get_end_of_line (CRInput *a_this, gboolean *a_eol) ;
00133 
00134 enum CRStatus
00135 cr_input_set_end_of_line (CRInput *a_this, gboolean a_eol) ;
00136 
00137 enum CRStatus
00138 cr_input_get_end_of_file (CRInput *a_this, gboolean *a_eof) ;
00139 
00140 enum CRStatus
00141 cr_input_set_end_of_file (CRInput *a_this, gboolean a_eof) ;
00142 
00143 enum CRStatus
00144 cr_input_set_line_num (CRInput *a_this, glong a_line_num) ;
00145 
00146 enum CRStatus
00147 cr_input_get_line_num (CRInput *a_this, glong *a_line_num) ;
00148 
00149 enum CRStatus
00150 cr_input_set_column_num (CRInput *a_this, glong a_col) ;
00151 
00152 enum CRStatus
00153 cr_input_get_column_num (CRInput *a_this, glong *a_col) ;
00154 
00155 enum CRStatus
00156 cr_input_increment_line_num (CRInput *a_this, 
00157                              glong a_increment) ;
00158 
00159 enum CRStatus
00160 cr_input_increment_col_num (CRInput *a_this,
00161                             glong a_increment) ;
00162         
00163 glong
00164 cr_input_get_nb_bytes_left (CRInput *a_this) ;
00165 
00166 enum CRStatus
00167 cr_input_end_of_input (CRInput *a_this, gboolean *a_end_of_input) ;
00168 
00169 G_END_DECLS
00170 
00171 #endif /*__CR_INPUT_SRC_H__*/
00172 

Generated on Wed Oct 1 01:36:45 2003 for Libcroco by doxygen 1.3.3