• Main Page
  • Related Pages
  • Namespaces
  • Data Structures
  • Files
  • File List
  • Globals

TsConfigLexer.h

Go to the documentation of this file.
00001 /** @file
00002 
00003     A brief file description
00004 
00005     @section license License
00006 
00007     Licensed to the Apache Software Foundation (ASF) under one
00008     or more contributor license agreements.  See the NOTICE file
00009     distributed with this work for additional information
00010     regarding copyright ownership.  The ASF licenses this file
00011     to you under the Apache License, Version 2.0 (the
00012     "License"); you may not use this file except in compliance
00013     with the License.  You may obtain a copy of the License at
00014 
00015     http://www.apache.org/licenses/LICENSE-2.0
00016 
00017     Unless required by applicable law or agreed to in writing, software
00018     distributed under the License is distributed on an "AS IS" BASIS,
00019     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00020     See the License for the specific language governing permissions and
00021     limitations under the License.
00022 */
00023 
00024 # if ! defined(TS_CONFIG_LEXER_HEADER)
00025 # define TS_CONFIG_LEXER_HEADER
00026 
00027 struct TsConfigHandlers; // forward declare.
00028 
00029 # if defined(__cplusplus)
00030     extern "C" {
00031 # endif
00032 
00033 /// Get the current line in the buffer during parsing.
00034 /// @return 1 based line number.
00035 extern int tsconfiglex_current_line(void);
00036 /// Get the current column in the buffer during parsing.
00037 /// @return 0 base column number.
00038 extern int tsconfiglex_current_col(void);
00039 
00040 /** Parse @a buffer.
00041 
00042     The @a buffer is parsed and the events dispatched via @a handlers.
00043 
00044     @note The contents of @a buffer are in general modified to handle
00045     null termination and processing escape codes in strings. Tokens
00046     passed to the handlers are simply offsets in to @a buffer and
00047     therefore have the same lifetime as @a buffer.
00048 
00049     @return Not sure.
00050  */
00051 extern int tsconfig_parse_buffer(
00052   struct TsConfigHandlers* handlers, ///< Syntax handlers.
00053   char* buffer, ///< Input buffer.
00054   size_t buffer_len ///< Length of input buffer.
00055 );
00056 
00057 # if defined(__cplusplus)
00058 }
00059 # endif
00060 
00061 # endif // TS_CONFIG_LEXER_HEADER

Generated by  doxygen 1.7.1