PDScanner.h

Go to the documentation of this file.

//
// PDScanner.h
//
// Copyright (c) 2012 - 2015 Karl-Johan Alm (http://github.com/kallewoof)
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#ifndef INCLUDED_PDScanner_h
#define INCLUDED_PDScanner_h

#include <sys/types.h>
#include "PDDefines.h"


extern PDScannerRef PDScannerCreateWithState(PDStateRef state);

extern PDScannerRef PDScannerCreateWithStateAndPopFunc(PDStateRef state, PDScannerPopFunc popFunc);

extern void PDScannerAttachFixedSizeBuffer(PDScannerRef scanner, char *buf, PDInteger len);


extern pd_stack PDScannerGenerateStackFromFixedBuffer(PDStateRef state, char *buf, PDInteger len);

extern PDBool PDScannerPopString(PDScannerRef scanner, char **value);

extern PDBool PDScannerPopStack(PDScannerRef scanner, pd_stack *value);

extern PDBool PDScannerPopUnknown(PDScannerRef scanner, char **value);

extern PDBool PDScannerEndOfStream(PDScannerRef scanner);

extern void PDScannerAssertString(PDScannerRef scanner, char *value);

// 
extern void PDScannerAssertStackType(PDScannerRef scanner);

extern void PDScannerAssertComplex(PDScannerRef scanner, const char *identifier);


extern void PDScannerSkip(PDScannerRef scanner, PDSize bytes);

extern PDInteger PDScannerPassSymbolCharacterType(PDScannerRef scanner, PDInteger symbolCharType);

extern PDBool PDScannerAttachFilter(PDScannerRef scanner, PDStreamFilterRef filter);

extern void PDScannerDetachFilter(PDScannerRef scanner);

extern PDInteger PDScannerReadStream(PDScannerRef scanner, PDInteger bytes, char *dest, PDInteger capacity);

extern PDInteger PDScannerReadStreamNext(PDScannerRef scanner, char *dest, PDInteger capacity);


extern void PDScannerPushContext(PDScannerRef scanner, void *ctxInfo, PDScannerBufFunc ctxBufFunc);

extern void PDScannerPopContext(PDScannerRef scanner);

extern void PDScannerSetLoopCap(PDInteger cap);

extern void PDScannerPopSymbol(PDScannerRef scanner);

extern void PDScannerPopSymbolRev(PDScannerRef scanner);

//

extern void PDScannerAlign(PDScannerRef scanner, PDOffset offset); 

extern void PDScannerTrim(PDScannerRef scanner, PDOffset bytes); 

extern void PDScannerReset(PDScannerRef scanner);



extern void PDScannerPrintStateTrace(PDScannerRef scanner);

#endif