ragel/ragel.h

   1 /*
   2  *  Copyright 2001-2007 Adrian Thurston <thurston@cs.queensu.ca>
   3  */
   4
   5 /*  This file is part of Ragel.
   6  *
   7  *  Ragel is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; either version 2 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  Ragel is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with Ragel; if not, write to the Free Software
  19  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 #ifndef _RAGEL_H
  23 #define _RAGEL_H
  24
  25 #include <stdio.h>
  26 #include <iostream>
  27 #include <fstream>
  28 #include <string>
  29 #include "vector.h"
  30 #include "config.h"
  31
  32 #define PROGNAME "ragel"
  33
  34 /* To what degree are machine minimized. */
  35 enum MinimizeLevel {
  36         MinimizeApprox,
  37         MinimizeStable,
  38         MinimizePartition1,
  39         MinimizePartition2
  40 };
  41
  42 enum MinimizeOpt {
  43         MinimizeNone,
  44         MinimizeEnd,
  45         MinimizeMostOps,
  46         MinimizeEveryOp
  47 };
  48
  49 /* Options. */
  50 extern MinimizeLevel minimizeLevel;
  51 extern MinimizeOpt minimizeOpt;
  52 extern char *machineSpec, *machineName;
  53 extern bool printStatistics;
  54 extern bool wantDupsRemoved;
  55
  56 /* Error reporting format. */
  57 enum ErrorFormat {
  58         ErrorFormatGNU,
  59         ErrorFormatMSVC,
  60 };
  61
  62 extern ErrorFormat errorFormat;
  63 extern int gblErrorCount;
  64 extern char mainMachine[];
  65
  66 /* Location in an input file. */
  67 struct InputLoc
  68 {
  69         const char *fileName;
  70         int line;
  71         int col;
  72 };
  73
  74 InputLoc makeInputLoc( const char *fileName, int line = 0, int col = 0 );
  75 std::ostream &operator<<( std::ostream &out, const InputLoc &loc );
  76
  77 /* Error reporting. */
  78 std::ostream &error();
  79 std::ostream &error( const InputLoc &loc );
  80 std::ostream &warning( const InputLoc &loc );
  81
  82 void terminateAllParsers( );
  83 void writeMachines( std::ostream &out, std::string hostData, char *inputFileName );
  84 void xmlEscapeHost( std::ostream &out, char *data, long len );
  85
  86 typedef Vector<const char *> ArgsVector;
  87 extern ArgsVector includePaths;
  88
  89 #endif /* _RAGEL_H */