libreoffice/autodoc/source/parser/cpp/pe_file.hxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef ADC_CPP_PE_FILE_HXX
#define ADC_CPP_PE_FILE_HXX



// USED SERVICES
    // BASE CLASSES
#include "cpp_pe.hxx"
    // COMPONENTS
#include <semantic/callf.hxx>
#include <semantic/sub_peu.hxx>
    // PARAMETERS


namespace cpp {

    class PeEnvironment;

    class PE_Namespace;
    class PE_Enum;
    class PE_Typedef;
    class PE_VarFunc;
    class PE_TemplateTop;
    class PE_Defines;
    class PE_Ignore;

class PE_File : public Cpp_PE
{
  public:
    enum E_State
    {
        std,            /// before class, struct or union
        in_extern,
        in_externC,
        size_of_states
    };

                        PE_File(
                            PeEnvironment &     io_rEnv );
                        ~PE_File();

    virtual void        Call_Handler(
                            const cpp::Token &  i_rTok );
    virtual Cpp_PE *    Handle_ChildFailure();

  private:
    typedef SubPe< PE_File, PE_Namespace>   SP_Namespace;
    typedef SubPe< PE_File, PE_Typedef>     SP_Typedef;
    typedef SubPe< PE_File, PE_VarFunc>     SP_VarFunc;
    typedef SubPe< PE_File, PE_TemplateTop> SP_Template;
    typedef SubPe< PE_File, PE_Defines>     SP_Defines;
    typedef SubPe< PE_File, PE_Ignore >     SP_Ignore;

    typedef SubPeUse< PE_File, PE_Namespace>    SPU_Namespace;
    typedef SubPeUse< PE_File, PE_Typedef>      SPU_Typedef;
    typedef SubPeUse< PE_File, PE_VarFunc>      SPU_VarFunc;
    typedef SubPeUse< PE_File, PE_TemplateTop>  SPU_Template;
    typedef SubPeUse< PE_File, PE_Defines>      SPU_Defines;
    typedef SubPeUse< PE_File, PE_Ignore>       SPU_Ignore;

    void                Setup_StatusFunctions();
    virtual void        InitData();
    virtual void        TransferData();
    void                Hdl_SyntaxError( const char *);

    void                SpReturn_VarFunc();
    void                SpReturn_Template();

    void                On_std_namespace(const char * i_sText);
    void                On_std_ClassKey(const char * i_sText);
    void                On_std_typedef(const char * i_sText);
    void                On_std_enum(const char * i_sText);
    void                On_std_VarFunc(const char * i_sText);
    void                On_std_template(const char * i_sText);
    void                On_std_extern(const char * i_sText);
    void                On_std_using(const char * i_sText);
    void                On_std_SwBracketRight(const char * i_sText);

    void                On_std_DefineName(const char * i_sText);
    void                On_std_MacroName(const char * i_sText);

    void                On_in_extern_Constant(const char * i_sText);
    void                On_in_extern_Ignore(const char * i_sText);
    void                On_in_externC_SwBracket_Left(const char * i_sText);
    void                On_in_externC_NoBlock(const char * i_sText);

    PeEnvironment &     access_Env()            { return *pEnv; }


    // DATA
    PeEnvironment *     pEnv;

    Dyn< PeStatusArray<PE_File> >
                        pStati;

    Dyn<SP_Namespace>   pSpNamespace;
    Dyn<SP_Typedef>     pSpTypedef;
    Dyn<SP_VarFunc>     pSpVarFunc;
    Dyn<SP_Template>    pSpTemplate;
    Dyn<SP_Defines>     pSpDefs;

    Dyn<SP_Ignore>      pSpIgnore;

    Dyn<SPU_Namespace>  pSpuNamespace;
    Dyn<SPU_Typedef>    pSpuTypedef;
    Dyn<SPU_VarFunc>    pSpuVarFunc;
    Dyn<SPU_Template>   pSpuTemplate;
    Dyn<SPU_Defines>    pSpuDefs;

    Dyn<SPU_Ignore>     pSpuUsing;
    Dyn<SPU_Ignore>     pSpuIgnoreFailure;

    bool                bWithinSingleExternC;   /** After 'extern "C"' without following '{',
                                                    waiting for the next function or variable to
                                                    set back to false.
                                                */
};

}   // namespace cpp



/* // Branches

namespace
    -> Named Namespace declaration
    -> Unnamed Namespace declaration
    -> Namespace alias definition

class struct union
    -> Class
    -> Predeclaration

typedef
    -> Typedef

enum
    -> Enum

extern
    -> Extern-"C"
    -> TypeDeclaration

TypeDeclaration
    -> FunctionDecl
    -> FunctionDef
    -> Variable

template
    -> TemplateClass
    -> TemplateFunction
    -> TemplateFunction/Method-Implementation
    -> TemplatePredeclaration

}
    -> End of Namespace
    -> End of Extern-"C"

asm
    -> AssemblerDeclaration

using
    -> Using-Declaration
    -> Using-Directive

*/

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */