/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef _IDLC_ASTDECLARATION_HXX_
#define _IDLC_ASTDECLARATION_HXX_

#include <idlc/idlc.hxx>
#include <registry/registry.hxx>

class AstScope;

// Enum defining the different kinds of Ast nodes
enum NodeType 
{
	NT_object,				// Denotes an object
	NT_service,				// Denotes an servcie
	NT_interface_member,	// Denotes an interface which is exported from object
	NT_service_member,		// Denotes an service which is exported from object
	NT_observes,			// Denotes an observed interface 
	NT_needs,				// Denotes an needed service
	NT_module,				// Denotes a module
	NT_root,				// Denotes the root of AST
	NT_interface,			// Denotes an interface
	NT_constants,		 	// Denotes a constant group
	NT_const,				// Denotes a constant
	NT_exception,			// Denotes an exception
	NT_attribute,			// Denotes an attribute
	NT_property,			// Denotes an property
	NT_operation,			// Denotes an operation
	NT_parameter,			// Denotes an op. parameter
	NT_union,				// Denotes a union
	NT_union_branch,		// Denotes a union branch
	NT_struct,              // Denotes either a plain struct type, or a
                            // polymorphic struct type template
    NT_type_parameter,      // Denotes a type parameter of a polymorphic struct
                            // type template
    NT_instantiated_struct, // Denotes an instantiated polymorphic struct type
	NT_member,				// Denotes a member in structure, exception
	NT_enum,				// Denotes an enumeration
	NT_enum_val,			// Denotes an enum. value
	NT_array,				// Denotes an IDL array
	NT_sequence,			// Denotes an IDL sequence
	NT_typedef,				// Denotes a typedef
	NT_predefined,			// Denotes a predefined type
	NT_singleton			// Denotes a singleton
};

class AstDeclaration
{
public:
	// Constructors
	AstDeclaration(NodeType type, const ::rtl::OString& name, AstScope* pScope);
	virtual ~AstDeclaration();

	// Data access
	void setName(const ::rtl::OString& name);
	const ::rtl::OString& getLocalName() const
		{ return m_localName; }
	const ::rtl::OString&	getScopedName() const
		{ return m_scopedName; }
	const ::rtl::OString&	getFullName()
		{ return m_fullName; }
	virtual const sal_Char*	getRelativName() const
		{ return m_fullName.getStr()+1; }
	AstScope* getScope()
		{ return m_pScope; }
	void setScope(AstScope* pSc)
		{ m_pScope = pSc; }
    NodeType getNodeType() const
		{ return m_nodeType; }
	sal_Bool isInMainfile() const
		{ return m_bInMainFile; }
	void setInMainfile(sal_Bool bInMainfile)
		{ m_bInMainFile = bInMainfile; }
	sal_Bool isImported() const
		{ return m_bImported; }
	void setImported(sal_Bool bImported)
		{ m_bImported = bImported; }
	sal_Int32 getLineNumber() const
		{ return m_lineNumber; }
	void setLineNumber(sal_Int32 lineNumber)
		{ m_lineNumber = lineNumber; }
	const ::rtl::OString& getFileName() const
		{ return m_fileName; }
	void setFileName(const ::rtl::OString& rFileName)
		{ m_fileName = rFileName; }
	const ::rtl::OUString& getDocumentation() const
		{ return m_documentation; }
	void setDocumentation(const ::rtl::OUString& rDocumentation)
		{ m_documentation = rDocumentation; }
	sal_Bool isAdded()
		{ return m_bIsAdded; }
	void markAsAdded()
		{ m_bIsAdded = sal_True; }

    virtual bool isType() const;

	sal_Bool hasAncestor(AstDeclaration* pDecl);

    void setPublished() { m_bPublished = true; }
    bool isPublished() const { return m_bPublished; }

	virtual sal_Bool dump(RegistryKey& rKey);

    bool isPredefined() { return m_bPredefined; }
    void setPredefined(bool bPredefined);
    
protected:
    ::rtl::OString		m_localName; 
	::rtl::OString		m_scopedName; 		// full qualified name
	::rtl::OString		m_fullName;			// full qualified name with '/' as seperator
	AstScope*			m_pScope;
	NodeType            m_nodeType;
	sal_Bool			m_bImported;		// imported ?
	sal_Bool			m_bIsAdded;			// mark declaration as added in scope
	sal_Bool			m_bInMainFile;		// defined in main file
    bool                m_bPublished;
    bool                m_bPredefined;
	sal_Int32			m_lineNumber;		// line number defined in	
	::rtl::OString		m_fileName;			// fileName	defined in
	::rtl::OUString		m_documentation; 	// fileName	defined in
};

#endif // _IDLC_ASTDECLARATION_HXX_