xref: /aoo4110/main/autodoc/source/parser_i/inc/s2_dsapi/docu_pe2.hxx (revision b1cdbd2c)

/**************************************************************
 *
 * 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 ADC_DSAPI_DOCU_PE2_HXX
#define ADC_DSAPI_DOCU_PE2_HXX



// USED SERVICES
	// BASE CLASSES
#include <s2_dsapi/tokintpr.hxx>
	// COMPONENTS
	// PARAMETERS

class ParserInfo;

namespace ary
{
namespace doc
{
    class OldIdlDocu;
}

namespace inf
{
    class DocuToken;
}   // namespace info
}   // namespace ary



namespace csi
{
namespace dsapi
{


class Token;
class DT_AtTag;

class SapiDocu_PE : public TokenInterpreter
{
  public:
						SapiDocu_PE(
						    ParserInfo &        io_rPositionInfo );
						~SapiDocu_PE();

	void				ProcessToken(
							DYN csi::dsapi::Token &
												let_drToken );

	virtual void		Process_AtTag(
							const Tok_AtTag &	i_rToken );
	virtual void		Process_HtmlTag(
							const Tok_HtmlTag &	i_rToken );
	virtual void		Process_XmlConst(
							const Tok_XmlConst &
												i_rToken );
	virtual void		Process_XmlLink_BeginTag(
							const Tok_XmlLink_BeginTag &
												i_rToken );
	virtual void		Process_XmlLink_EndTag(
							const Tok_XmlLink_EndTag &
												i_rToken );
	virtual void		Process_XmlFormat_BeginTag(
							const Tok_XmlFormat_BeginTag &
												i_rToken );
	virtual void		Process_XmlFormat_EndTag(
							const Tok_XmlFormat_EndTag &
												i_rToken );
	virtual void		Process_Word(
							const Tok_Word &	i_rToken );
	virtual void		Process_Comma();
	virtual void		Process_DocuEnd();
	virtual void		Process_EOL();
	virtual void		Process_White();


	DYN ary::doc::OldIdlDocu *
							ReleaseJustParsedDocu();

	bool				IsComplete() const;

  private:
	enum E_State
	{
		e_none = 0,
		st_short,
		st_description,
		st_attags,
		st_complete
	};

	typedef void ( SapiDocu_PE::*F_TokenAdder )( DYN ary::inf::DocuToken & let_drNewToken );

	void				AddDocuToken2Void(
							DYN ary::inf::DocuToken &
												let_drNewToken );
	void				AddDocuToken2Short(
							DYN ary::inf::DocuToken &
												let_drNewToken );
	void				AddDocuToken2Description(
							DYN ary::inf::DocuToken &
												let_drNewToken );
	void				AddDocuToken2Deprecated(
							DYN ary::inf::DocuToken &
												let_drNewToken );
	void				AddDocuToken2CurAtTag(
							DYN ary::inf::DocuToken &
												let_drNewToken );
	void				SetCurParameterAtTagName(
							DYN ary::inf::DocuToken &
												let_drNewToken );
	void				SetCurSeeAlsoAtTagLinkText(
							DYN ary::inf::DocuToken &
												let_drNewToken );
	void				SetCurSeeAlsoAtTagLinkText_2(
							DYN ary::inf::DocuToken &
												let_drNewToken );
	void				SetCurSeeAlsoAtTagLinkText_3(
							DYN ary::inf::DocuToken &
												let_drNewToken );
	void				SetCurSinceAtTagVersion_OOo(
							DYN ary::inf::DocuToken &
												let_drNewToken );
    void                SetCurSinceAtTagVersion_AOO(
                            DYN ary::inf::DocuToken &
                                                let_drNewToken );
	void				SetCurSinceAtTagVersion_Number(
							DYN ary::inf::DocuToken &
												let_drNewToken );
	void				AddDocuToken2SinceAtTag(
							DYN ary::inf::DocuToken &
												let_drNewToken );

	bool				CheckVersionSyntax_OOo(
                            const String &      i_versionPart1 );
	bool				CheckVersionSyntax_Number(
                            const String &      i_versionPart2 );
	// DATA
	Dyn<ary::doc::OldIdlDocu>
						pDocu;
	E_State				eState;
	ParserInfo *        pPositionInfo;
	F_TokenAdder		fCurTokenAddFunction;

	Dyn<DT_AtTag>	    pCurAtTag;
    String              sCurDimAttribute;
    StreamStr           sCurAtSeeType_byXML;
};

}   // namespace dsapi
}   // namespace csi


// IMPLEMENTATION


#endif