ChaiScript/include/chaiscript/language/chaiscript_common.hpp

// This file is distributed under the BSD License.
// See "license.txt" for details.
// Copyright 2009-2010, Jonathan Turner (jturner@minnow-lang.org)
// and Jason Turner (lefticus@gmail.com)
// http://www.chaiscript.com

#ifndef _CHAISCRIPT_COMMON_HPP
#define	_CHAISCRIPT_COMMON_HPP

namespace chaiscript
{
    typedef ModulePtr (*Create_Module_Func)();

    /**
     * Types of AST nodes available to the parser and eval
     */
    class Token_Type { public: enum Type { Error, Int, Float, Id, Char, Str, Eol, Fun_Call, Inplace_Fun_Call, Arg_List, Variable, Equation, Var_Decl,
        Comparison, Additive, Multiplicative, Array_Call, Dot_Access, Quoted_String, Single_Quoted_String,
        Lambda, Block, Def, While, If, For, Inline_Array, Inline_Map, Return, File, Prefix, Break, Map_Pair, Value_Range,
        Inline_Range, Annotation, Try, Catch, Finally, Method, Attr_Decl, Shift, Equality, Bitwise_And, Bitwise_Xor, Bitwise_Or, 
        Logical_And, Logical_Or}; };

    namespace
    {
      /**
       * Helper lookup to get the name of each node type
       */
      const char *token_type_to_string(int tokentype) {
        const char *token_types[] = { "Internal Parser Error", "Int", "Float", "Id", "Char", "Str", "Eol", "Fun_Call", "Inplace_Fun_Call", "Arg_List", "Variable", "Equation", "Var_Decl",
          "Comparison", "Additive", "Multiplicative", "Array_Call", "Dot_Access", "Quoted_String", "Single_Quoted_String",
          "Lambda", "Block", "Def", "While", "If", "For", "Inline_Array", "Inline_Map", "Return", "File", "Prefix", "Break", "Map_Pair", "Value_Range",
          "Inline_Range", "Annotation", "Try", "Catch", "Finally", "Method", "Attr_Decl", "Shift", "Equality", "Bitwise_And", "Bitwise_Xor", "Bitwise_Or", 
          "Logical_And", "Logical_Or"};

        return token_types[tokentype];
      }
    }

    /**
     * Convenience type for file positions
     */
    struct File_Position {
        int line;
        int column;

        File_Position(int file_line, int file_column)
            : line(file_line), column(file_column) { }

        File_Position() : line(0), column(0) { }
    };

    typedef boost::shared_ptr<struct Token> TokenPtr;

    /**
     * The struct that doubles as both a parser token and an AST node
     */
    struct Token {
        std::string text;
        int identifier;
        const char *filename;
        File_Position start, end;
        bool is_cached;
        Boxed_Value cached_value;

        std::vector<TokenPtr> children;
        TokenPtr annotation;

        Token(const std::string &token_text, int id, const char *fname) :
            text(token_text), identifier(id), filename(fname), is_cached(false) { }

        Token(const std::string &token_text, int id, const char *fname, int start_line, int start_col, int end_line, int end_col) :
            text(token_text), identifier(id), filename(fname), is_cached(false) {

            start.line = start_line;
            start.column = start_col;
            end.line = end_line;
            end.column = end_col;
        }
    };

    /**
     * Errors generated during parsing or evaluation
     */
    struct Eval_Error : public std::runtime_error {
        std::string reason;
        File_Position start_position;
        File_Position end_position;
        const char *filename;

        Eval_Error(const std::string &why, const File_Position &where, const char *fname) :
            std::runtime_error("Error: \"" + why + "\" " +
                (std::string(fname) != "__EVAL__" ? ("in '" + std::string(fname) + "' ") : "during evaluation ") +
                + "at (" + boost::lexical_cast<std::string>(where.line) + ", " +
                boost::lexical_cast<std::string>(where.column) + ")"),
            reason(why), start_position(where), end_position(where), filename(fname)
        { }

        Eval_Error(const std::string &why, const TokenPtr &where)
            : std::runtime_error("Error: \"" + why + "\" " +
                (std::string(where->filename) != "__EVAL__" ? ("in '" + std::string(where->filename) + "' ") : "during evaluation ") +
                "at (" + boost::lexical_cast<std::string>(where->start.line) + ", " +
                boost::lexical_cast<std::string>(where->start.column) + ")"),
              reason(why), start_position(where->start), end_position(where->end), filename(where->filename) {
        }

        virtual ~Eval_Error() throw() {}
    };

    /**
     * Errors generated when loading a file
     */
    struct File_Not_Found_Error : public std::runtime_error {
        File_Not_Found_Error(const std::string &filename)
           : std::runtime_error("File Not Found: " + filename)
        { }

        virtual ~File_Not_Found_Error() throw() {}
    };


    /**
     * Special type for returned values
     */
    struct Return_Value {
        Boxed_Value retval;
        TokenPtr location;

        Return_Value(const Boxed_Value &return_value, const TokenPtr where) : retval(return_value), location(where) { }
    };

    /**
     * Special type indicating a call to 'break'
     */
    struct Break_Loop {
        TokenPtr location;

        Break_Loop(const TokenPtr where) : location(where) { }
    };
}

#endif	/* _CHAISCRIPT_COMMON_HPP */