You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

125 lines
4.2 KiB

/* parsing routines for the counted string class. These
* routines provide generic parsing aid as well some fairly
* complex routines targeted toward specific needs.
* General information - read this:
* All routines work on a single CStr object, which must be supplied
* during construction. The parse class keeps an internal pointer of
* where the next parse operation is to start (you could also say
* this is where the last parse operation stopped).
* Each parse operation carried out by this package starts from the
* parse pointer, parses the caller-requested element (e.g. an
* integer or delemited string) and the update the parse pointer. If
* the caller tries to parse beyond the end of the original string,
* an error is returned. In general, all functions return a parsRet
* error code and all require the parseObj to be the first parameter.
* The to-be-parsed string provided to the parse object MUST NOT be
* freed or modified by the caller during the lifetime of the parse
* object. However, the caller must free it when it is no longer needed.
* Optinally, the parse object can be instructed to do that. All objects
* returned by the parse routines must be freed by the caller. For
* simpler data types (like integers), the caller must provide the
* necessary buffer space.
* begun 2005-09-09 rgerhards
* Copyright (C) 2005 by Rainer Gerhards and Adiscon GmbH
* This file is part of rsyslog.
* Rsyslog is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* Rsyslog is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with Rsyslog. If not, see <>.
* A copy of the GPL can be found in the file "COPYING" in this distribution.
#define _PARSE_H_INCLUDED__ 1
#include "stringbuf.h"
* The parse object
struct rsParsObject
#ifndef NDEBUG
rsObjID OID; /**< object ID */
cstr_t *pCStr; /**< pointer to the string object we are parsing */
int iCurrPos; /**< current parsing position (char offset) */
typedef struct rsParsObject rsParsObj;
/* BEGIN "inline"-like functions */
/* END "inline"-like functions */
int rsParsGetParsePointer(rsParsObj *pThis);
* Construct a rsPars object.
rsRetVal rsParsConstruct(rsParsObj **ppThis);
rsRetVal rsParsAssignString(rsParsObj *pThis, cstr_t *pCStr);
/* parse an integer. The parse pointer is advanced */
rsRetVal parsInt(rsParsObj *pThis, int* pInt);
/* Skip whitespace. Often used to trim parsable entries. */
rsRetVal parsSkipWhitespace(rsParsObj *pThis);
/* Parse string up to a delimiter.
* Input:
* cDelim - the delimiter
* The following two are for whitespace stripping,
* 0 means "no", 1 "yes"
* - bTrimLeading
* - bTrimTrailing
* Output:
* ppCStr Pointer to the parsed string
rsRetVal parsDelimCStr(rsParsObj *pThis, cstr_t **ppCStr, char cDelim, int bTrimLeading, int bTrimTrailing, int bConvLower);
rsRetVal parsSkipAfterChar(rsParsObj *pThis, char c);
rsRetVal parsQuotedCStr(rsParsObj *pThis, cstr_t **ppCStr);
rsRetVal rsParsConstructFromSz(rsParsObj **ppThis, unsigned char *psz);
rsRetVal rsParsDestruct(rsParsObj *pThis);
int parsIsAtEndOfParseString(rsParsObj *pThis);
int parsGetCurrentPosition(rsParsObj *pThis);
char parsPeekAtCharAtParsPtr(rsParsObj *pThis);
rsRetVal parsAddrWithBits(rsParsObj *pThis, struct NetAddr **pIP, int *pBits);
#if 0 /* later! - but leave it in in case we need it some day... */
/* Parse a property
* This is a complex parsing routine. It parses an property
* entry suitable for use in the property replacer. It is currently
* just an idea if this should be a parser function.
parsRet parsProp(parseObj *pThis, ?? **pPropEtry);
* Local variables:
* c-indent-level: 8
* c-basic-offset: 8
* tab-width: 8
* End:
* vi:set ai: