parsev2.h

/***********************************************************************
 ssx/parsev2.h - Declares the SSQLS v2 language parsing related classes.

 Copyright (c) 2009 by Warren Young and (c) 2009-2010 by Educational
 Technology Resources, Inc.  Others may also hold copyrights on code
 in this file.  See the CREDITS.txt file in the top directory of the
 distribution for details.

 This file is part of MySQL++.

 MySQL++ is free software; you can redistribute it and/or modify it
 under the terms of the GNU Lesser General Public License as published
 by the Free Software Foundation; either version 2.1 of the License, or
 (at your option) any later version.

 MySQL++ is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with MySQL++; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
 USA
***********************************************************************/

#if !defined(MYSQLPP_SSX_PARSEV2_H)
#define MYSQLPP_SSX_PARSEV2_H

#include <exceptions.h>

#include <cassert>
#include <fstream>
#include <string>
#include <vector>

class ParseV2
{
public:
    typedef std::vector<std::string> StringList;

    typedef StringList::const_iterator StringListIt;

    class File
    {
    public:
        File(const char* file_name);

        void error(const std::string& msg) const;

        void error(const std::ostringstream& msg) const
                { error(msg.str()); }

        const char* name() const { return file_name_.c_str(); }

        void parse_error(const std::string& msg) const;

        void parse_error(const std::ostringstream& msg) const
                { error(msg.str()); }

        bool read_line(std::string& line, bool& subdirective);

    private:
        void add_directory_to_search_path(const char* filepath);

        void split_path(StringList& parts, const std::string& path) const;

        std::ifstream ifs_;

        std::string file_name_;

        size_t line_number_;

        static StringList search_path_;
    };

    class Line
    {
    public:
        virtual ~Line() { }

        static Line* parse(const StringList& tl, bool subdirective,
                const File& file);

        virtual void print(std::ostream& os) const = 0;

    protected:
        Line() { }
    };

    typedef std::vector<Line*> LineList;

    typedef LineList::const_iterator LineListIt;

    class Field : public Line
    {
    public:
        Field(const std::string& name, const std::string& type,
                bool is_unsigned = false, bool is_null = false,
                bool is_autoinc = false, bool is_key = false,
                const std::string& alias = 0) :
        name_(name),
        type_(type),
        is_autoinc_(is_autoinc),
        is_key_(is_key),
        is_null_(is_null),
        is_unsigned_(is_unsigned),
        alias_(alias)
        {
        }

        static Field* parse(const StringList& tl, bool subdirective,
                const File& file);

        void print(std::ostream& os) const;

        class Type
        {
        public:
            enum Value {
                ft_tinyint,     
                ft_smallint,    
                ft_mediumint,   
                ft_bigint,      
                ft_float,       
                ft_double,      
                ft_string,      
                ft_blob,        
                ft_date,        
                ft_datetime,    
                ft_time,        
                ft_set          
            };

            Type(const std::string& s);

            Type(Value v) :
            value_(v)
            {
            }

            void print(std::ostream& os) const;

            operator Value() const { return value_; }

            bool operator ==(const Type& rhs) const
                    { return value_ == rhs.value_; }

        private:
            Value value_;
        };

    private:
        std::string name_;  
        Type type_;         
        bool is_autoinc_;   
        bool is_key_;       
        bool is_null_;      
        bool is_unsigned_;  
        std::string alias_; 
    };

    class Include : public Line
    {
    public:
        Include(const char* file_name) :
        pp2_(new ParseV2(file_name))
        {
        }

        ~Include() { pp2_->clear(); delete pp2_; }

        // sub-parse's LineList
        LineListIt begin() const { return pp2_->begin(); }

        LineListIt end() const { return pp2_->end(); }

        static Include* parse(const StringList& tl, bool subdirective,
                const File& file);

    private:
        // Never called.  Include directives don't appear in the parse
        // list; the included file's contents appear in its place
        // instead.  Since this method only exists to test parsing
        // behavior, we can't be called.
        void print(std::ostream&) const { assert(0); }

        ParseV2* pp2_;
    };

    class Option : public Line
    {
    public:
        virtual ~Option() { }

        static Option* parse(const StringList& tl, bool subdirective,
                const File& file);

    protected:
        Option(const std::string& value) :
        value_(value)
        {
        }

        static bool parse_bool(const std::string& value);

        const char* value() const { return value_.c_str(); }
    
    private:
        // The option's raw value string
        std::string value_;
    };

    class AccessorStyleOption : public Option
    {
    public:
        AccessorStyleOption(const std::string& value, const File& file) :
        Option(value),
        type_(AccessorStyleOption::parse_type(value, file))
        {
        }

        void print(std::ostream& os) const;

    private:
        enum Type {
            unknown,            
            camel_case_lower,   
            camel_case_upper,   
            stroustrup,         
            overloaded          
        };

        static Type parse_type(const std::string& style,
                const File& file);

        Type type_;
    };

    class ExceptionOnSchemaMismatchOption : public Option
    {
    public:
        ExceptionOnSchemaMismatchOption(const std::string& value) :
        Option(value),
        throw_(Option::parse_bool(value))
        {
        }

        operator bool() const { return throw_; }

        void print(std::ostream& os) const;

    private:
        bool throw_;    
    };

    class HeaderExtensionOption : public Option
    {
    public:
        HeaderExtensionOption(const std::string& value) :
        Option(value)
        {
        }

        const char* extension() const { return value(); }

        void print(std::ostream& os) const;
    };

    class ImplementationExtensionOption : public Option
    {
    public:
        ImplementationExtensionOption(const std::string& value) :
        Option(value)
        {
        }

        const char* extension() const { return value(); }

        void print(std::ostream& os) const;
    };

    class Table : public Line
    {
    public:
        Table(const std::string& name, const std::string& alias,
                const std::string& filebase);

        static Table* parse(const StringList& tl, bool subdirective,
                const File& file);

        void print(std::ostream& os) const;

    private:
        std::string name_, alias_, filebase_;
    };

    class FileException : public mysqlpp::Exception
    {
    public:
        FileException(const std::string& what) : Exception(what) { }
    };

    class ParseException : public mysqlpp::Exception
    {
    public:
        ParseException(const std::string& what,
                const std::string& file_name, size_t line) :
        Exception(what),
        file_name_(file_name),
        line_(line)
        {
        }

        ~ParseException() throw() { }

        const char* file_name() const { return file_name_.c_str(); }

        size_t line() const { return line_; }

    private:
        std::string file_name_;
        size_t line_;
    };

    ParseV2(const char* file_name);

    ~ParseV2()
    {
        for (LineListIt it = lines_.begin(); it != lines_.end(); ++it) {
            delete *it;
        }
    }

    LineListIt begin() const { return lines_.begin(); }

    void clear() { lines_.clear(); }

    LineListIt end() const { return lines_.end(); }

private:
    void tokenize(StringList& tokens, const std::string& line) const;

    File file_;

    LineList lines_;
};

std::ostream& operator<<(std::ostream& os, const ParseV2::Line& line);

#endif // !defined(MYSQLPP_SSX_PARSEV2_H)