2d118765fe
2007/08/31 14:45:37 np 1.12.2.2: #i80569# remove wrong pchs. 2007/08/10 10:37:10 np 1.12.2.1: #i23626 correct spacing in autodoc output#
585 lines
16 KiB
C++
585 lines
16 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: docu_pe2.cxx,v $
|
|
*
|
|
* $Revision: 1.13 $
|
|
*
|
|
* last change: $Author: vg $ $Date: 2007-09-18 14:25:24 $
|
|
*
|
|
* The Contents of this file are made available subject to
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
|
*
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2005 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library 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 this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
************************************************************************/
|
|
|
|
#include <precomp.h>
|
|
#include <s2_dsapi/docu_pe2.hxx>
|
|
|
|
|
|
// NOT FULLY DEFINED SERVICES
|
|
#include <ary_i/codeinf2.hxx>
|
|
#include <ary_i/d_token.hxx>
|
|
#include <parser/parserinfo.hxx>
|
|
#include <adc_cl.hxx>
|
|
#include <adc_msg.hxx>
|
|
#include <s2_dsapi/dsapitok.hxx>
|
|
#include <s2_dsapi/tk_atag2.hxx>
|
|
#include <s2_dsapi/tk_html.hxx>
|
|
#include <s2_dsapi/tk_docw2.hxx>
|
|
#include <s2_dsapi/tk_xml.hxx>
|
|
|
|
|
|
#ifdef UNX
|
|
#define strnicmp strncasecmp
|
|
#endif
|
|
|
|
|
|
namespace csi
|
|
{
|
|
namespace dsapi
|
|
{
|
|
|
|
|
|
const char * AtTagTitle(
|
|
const Tok_AtTag & i_rToken );
|
|
|
|
|
|
SapiDocu_PE::SapiDocu_PE(ParserInfo & io_rPositionInfo)
|
|
: pDocu(0),
|
|
eState(e_none),
|
|
pPositionInfo(&io_rPositionInfo),
|
|
fCurTokenAddFunction(&SapiDocu_PE::AddDocuToken2Void),
|
|
pCurAtTag(0),
|
|
sCurDimAttribute(),
|
|
sCurAtSeeType_byXML(200)
|
|
{
|
|
}
|
|
|
|
SapiDocu_PE::~SapiDocu_PE()
|
|
{
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::ProcessToken( DYN csi::dsapi::Token & let_drToken )
|
|
{
|
|
if (IsComplete())
|
|
{
|
|
pDocu = 0;
|
|
eState = e_none;
|
|
}
|
|
|
|
if ( eState == e_none )
|
|
{
|
|
pDocu = new ary::info::CodeInformation;
|
|
eState = st_short;
|
|
fCurTokenAddFunction = &SapiDocu_PE::AddDocuToken2Short;
|
|
}
|
|
|
|
csv_assert(pDocu);
|
|
|
|
let_drToken.Trigger(*this);
|
|
delete &let_drToken;
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_AtTag( const Tok_AtTag & i_rToken )
|
|
{
|
|
if (NOT pCurAtTag)
|
|
{
|
|
eState = st_attags;
|
|
fCurTokenAddFunction = &SapiDocu_PE::AddDocuToken2CurAtTag;
|
|
}
|
|
else
|
|
{
|
|
csv_assert(eState == st_attags);
|
|
pDocu->AddAtTag(*pCurAtTag.Release());
|
|
}
|
|
|
|
if (i_rToken.Id() == Tok_AtTag::param)
|
|
{
|
|
pCurAtTag = new DT_ParameterAtTag;
|
|
fCurTokenAddFunction = &SapiDocu_PE::SetCurParameterAtTagName;
|
|
}
|
|
else if (i_rToken.Id() == Tok_AtTag::see)
|
|
{
|
|
pCurAtTag = new DT_SeeAlsoAtTag;
|
|
fCurTokenAddFunction = &SapiDocu_PE::SetCurSeeAlsoAtTagLinkText;
|
|
}
|
|
else if (i_rToken.Id() == Tok_AtTag::deprecated)
|
|
{
|
|
pDocu->SetDeprecated();
|
|
pCurAtTag = new DT_StdAtTag(""); // Dummy that will not be used.
|
|
fCurTokenAddFunction = &SapiDocu_PE::AddDocuToken2Deprecated;
|
|
}
|
|
else if (i_rToken.Id() == Tok_AtTag::since)
|
|
{
|
|
pCurAtTag = new DT_SinceAtTag;
|
|
fCurTokenAddFunction = &SapiDocu_PE::SetCurSinceAtTagVersion;
|
|
}
|
|
else
|
|
{
|
|
pCurAtTag = new DT_StdAtTag( AtTagTitle(i_rToken) );
|
|
fCurTokenAddFunction = &SapiDocu_PE::AddDocuToken2CurAtTag;
|
|
}
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_HtmlTag( const Tok_HtmlTag & i_rToken )
|
|
{
|
|
if (eState == st_short AND i_rToken.IsParagraphStarter())
|
|
{
|
|
eState = st_description;
|
|
fCurTokenAddFunction = &SapiDocu_PE::AddDocuToken2Description;
|
|
}
|
|
|
|
// Workaround special for some errors in API docu:
|
|
if ( strnicmp("<true",i_rToken.Text(),5 ) == 0 )
|
|
{
|
|
if ( strcmp("<TRUE/>",i_rToken.Text()) != 0 )
|
|
TheMessages().Out_InvalidConstSymbol( i_rToken.Text(),
|
|
pPositionInfo->CurFile(),
|
|
pPositionInfo->CurLine() );
|
|
(this->*fCurTokenAddFunction)( *new DT_TextToken("<b>true</b>") );
|
|
return;
|
|
}
|
|
else if ( strnicmp("<false",i_rToken.Text(),6 ) == 0 )
|
|
{
|
|
if ( strcmp("<FALSE/>",i_rToken.Text()) != 0 )
|
|
TheMessages().Out_InvalidConstSymbol( i_rToken.Text(),
|
|
pPositionInfo->CurFile(),
|
|
pPositionInfo->CurLine() );
|
|
(this->*fCurTokenAddFunction)( *new DT_TextToken("<b>false</b>") );
|
|
return;
|
|
}
|
|
else if ( strnicmp("<NULL",i_rToken.Text(),5 ) == 0 )
|
|
{
|
|
if ( strcmp("<NULL/>",i_rToken.Text()) != 0 )
|
|
TheMessages().Out_InvalidConstSymbol( i_rToken.Text(),
|
|
pPositionInfo->CurFile(),
|
|
pPositionInfo->CurLine() );
|
|
(this->*fCurTokenAddFunction)( *new DT_TextToken("<b>null</b>") );
|
|
return;
|
|
}
|
|
else if ( strnicmp("<void",i_rToken.Text(),5 ) == 0 )
|
|
{
|
|
if ( strcmp("<void/>",i_rToken.Text()) != 0 )
|
|
TheMessages().Out_InvalidConstSymbol( i_rToken.Text(),
|
|
pPositionInfo->CurFile(),
|
|
pPositionInfo->CurLine() );
|
|
(this->*fCurTokenAddFunction)( *new DT_TextToken("<b>void</b>") );
|
|
return;
|
|
}
|
|
|
|
(this->*fCurTokenAddFunction)( *new DT_Style(i_rToken.Text(),false) );
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_XmlConst( const Tok_XmlConst & i_rToken )
|
|
{
|
|
(this->*fCurTokenAddFunction)(*new DT_MupConst(i_rToken.Text()));
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_XmlLink_BeginTag( const Tok_XmlLink_BeginTag & i_rToken )
|
|
{
|
|
switch (i_rToken.Id())
|
|
{
|
|
case Tok_XmlLink_Tag::e_const:
|
|
(this->*fCurTokenAddFunction)(*new DT_Style("<b>",false));
|
|
break;
|
|
case Tok_XmlLink_Tag::member:
|
|
(this->*fCurTokenAddFunction)(*new DT_MupMember(i_rToken.Scope()));
|
|
break;
|
|
case Tok_XmlLink_Tag::type:
|
|
(this->*fCurTokenAddFunction)(*new DT_MupType(i_rToken.Scope()));
|
|
break;
|
|
default:
|
|
// Do nothing.
|
|
;
|
|
}
|
|
|
|
if ( i_rToken.Dim().length() > 0 )
|
|
sCurDimAttribute = i_rToken.Dim();
|
|
else
|
|
sCurDimAttribute.clear();
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_XmlLink_EndTag( const Tok_XmlLink_EndTag & i_rToken )
|
|
{
|
|
switch (i_rToken.Id())
|
|
{
|
|
case Tok_XmlLink_Tag::e_const:
|
|
(this->*fCurTokenAddFunction)(*new DT_Style("</b>",false));
|
|
break;
|
|
case Tok_XmlLink_Tag::member:
|
|
(this->*fCurTokenAddFunction)(*new DT_MupMember(true));
|
|
break;
|
|
case Tok_XmlLink_Tag::type:
|
|
(this->*fCurTokenAddFunction)(*new DT_MupType(true));
|
|
break;
|
|
default:
|
|
// Do nothing.
|
|
;
|
|
}
|
|
if ( sCurDimAttribute.length() > 0 )
|
|
{
|
|
(this->*fCurTokenAddFunction)( *new DT_TextToken(sCurDimAttribute.c_str()) );
|
|
sCurDimAttribute.clear();
|
|
}
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_XmlFormat_BeginTag( const Tok_XmlFormat_BeginTag & i_rToken )
|
|
{
|
|
switch (i_rToken.Id())
|
|
{
|
|
case Tok_XmlFormat_Tag::code:
|
|
(this->*fCurTokenAddFunction)(*new DT_Style("<code>",false));
|
|
break;
|
|
case Tok_XmlFormat_Tag::listing:
|
|
(this->*fCurTokenAddFunction)(*new DT_Style("<pre>",true));
|
|
break;
|
|
case Tok_XmlFormat_Tag::atom:
|
|
(this->*fCurTokenAddFunction)(*new DT_Style("<code>",true));
|
|
break;
|
|
default:
|
|
// Do nothing.
|
|
;
|
|
}
|
|
if ( i_rToken.Dim().length() > 0 )
|
|
sCurDimAttribute = i_rToken.Dim();
|
|
else
|
|
sCurDimAttribute.clear();
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_XmlFormat_EndTag( const Tok_XmlFormat_EndTag & i_rToken )
|
|
{
|
|
switch (i_rToken.Id())
|
|
{
|
|
case Tok_XmlFormat_Tag::code:
|
|
(this->*fCurTokenAddFunction)(*new DT_Style("</code>",false));
|
|
break;
|
|
case Tok_XmlFormat_Tag::listing:
|
|
(this->*fCurTokenAddFunction)(*new DT_Style("</pre>",true));
|
|
break;
|
|
case Tok_XmlFormat_Tag::atom:
|
|
(this->*fCurTokenAddFunction)(*new DT_Style("</code>",true));
|
|
break;
|
|
default:
|
|
// Do nothing.
|
|
;
|
|
}
|
|
if ( sCurDimAttribute.length() > 0 )
|
|
{
|
|
(this->*fCurTokenAddFunction)( *new DT_TextToken(sCurDimAttribute.c_str()) );
|
|
sCurDimAttribute.clear();
|
|
}
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_Word( const Tok_Word & i_rToken )
|
|
{
|
|
(this->*fCurTokenAddFunction)(*new DT_TextToken(i_rToken.Text()));
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_Comma()
|
|
{
|
|
csv_assert(1==7);
|
|
// (this->*fCurTokenAddFunction)(*new DT_Comma(i_rToken.Text()));
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_DocuEnd()
|
|
{
|
|
eState = st_complete;
|
|
if (pCurAtTag)
|
|
pDocu->AddAtTag(*pCurAtTag.Release());
|
|
fCurTokenAddFunction = &SapiDocu_PE::AddDocuToken2Void;
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_EOL()
|
|
{
|
|
(this->*fCurTokenAddFunction)(*new DT_EOL);
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::Process_White()
|
|
{
|
|
(this->*fCurTokenAddFunction)(*new DT_White);
|
|
}
|
|
|
|
DYN ary::info::CodeInformation *
|
|
SapiDocu_PE::ReleaseJustParsedDocu()
|
|
{
|
|
if (IsComplete())
|
|
{
|
|
eState = e_none;
|
|
return pDocu.Release();
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
|
|
bool
|
|
SapiDocu_PE::IsComplete() const
|
|
{
|
|
return eState == st_complete;
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::AddDocuToken2Void( DYN ary::info::DocuToken & let_drNewToken )
|
|
{
|
|
delete &let_drNewToken;
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::AddDocuToken2Short( DYN ary::info::DocuToken & let_drNewToken )
|
|
{
|
|
csv_assert(pDocu);
|
|
pDocu->AddToken2Short(let_drNewToken);
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::AddDocuToken2Description( DYN ary::info::DocuToken & let_drNewToken )
|
|
{
|
|
csv_assert(pDocu);
|
|
pDocu->AddToken2Description(let_drNewToken);
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::AddDocuToken2Deprecated( DYN ary::info::DocuToken & let_drNewToken )
|
|
{
|
|
csv_assert(pDocu);
|
|
pDocu->AddToken2DeprecatedText(let_drNewToken);
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::AddDocuToken2CurAtTag( DYN ary::info::DocuToken & let_drNewToken )
|
|
{
|
|
csv_assert(pCurAtTag);
|
|
pCurAtTag->AddToken(let_drNewToken);
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::SetCurParameterAtTagName( DYN ary::info::DocuToken & let_drNewToken )
|
|
{
|
|
if (let_drNewToken.IsWhiteOnly())
|
|
{
|
|
delete &let_drNewToken;
|
|
return;
|
|
}
|
|
|
|
csv_assert(pCurAtTag);
|
|
DT_TextToken * dpText = dynamic_cast< DT_TextToken* >(&let_drNewToken);
|
|
if (dpText != 0)
|
|
pCurAtTag->SetName(dpText->GetText());
|
|
else
|
|
pCurAtTag->SetName("parameter ?");
|
|
delete &let_drNewToken;
|
|
fCurTokenAddFunction = &SapiDocu_PE::AddDocuToken2CurAtTag;
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::SetCurSeeAlsoAtTagLinkText( DYN ary::info::DocuToken & let_drNewToken )
|
|
{
|
|
csv_assert(pCurAtTag);
|
|
|
|
if (let_drNewToken.IsWhiteOnly())
|
|
{
|
|
delete &let_drNewToken;
|
|
return;
|
|
}
|
|
|
|
DT_TextToken * pText = dynamic_cast< DT_TextToken* >(&let_drNewToken);
|
|
if (pText != 0)
|
|
pCurAtTag->SetName(pText->GetText());
|
|
else
|
|
{
|
|
DT_MupType *
|
|
pTypeBegin = dynamic_cast< DT_MupType* >(&let_drNewToken);
|
|
DT_MupMember *
|
|
pMemberBegin = dynamic_cast< DT_MupMember* >(&let_drNewToken);
|
|
if (pTypeBegin != 0 OR pMemberBegin != 0)
|
|
{
|
|
sCurAtSeeType_byXML.reset();
|
|
|
|
sCurAtSeeType_byXML
|
|
<< ( pTypeBegin != 0
|
|
? pTypeBegin->Scope()
|
|
: pMemberBegin->Scope() );
|
|
|
|
if (sCurAtSeeType_byXML.tellp() > 0)
|
|
{
|
|
sCurAtSeeType_byXML
|
|
<< "::";
|
|
}
|
|
delete &let_drNewToken;
|
|
fCurTokenAddFunction = &SapiDocu_PE::SetCurSeeAlsoAtTagLinkText_2;
|
|
return;
|
|
}
|
|
else
|
|
{
|
|
pCurAtTag->SetName("? (no identifier found)");
|
|
}
|
|
}
|
|
delete &let_drNewToken;
|
|
fCurTokenAddFunction = &SapiDocu_PE::AddDocuToken2CurAtTag;
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::SetCurSeeAlsoAtTagLinkText_2( DYN ary::info::DocuToken & let_drNewToken )
|
|
{
|
|
csv_assert(pCurAtTag);
|
|
|
|
if (let_drNewToken.IsWhiteOnly())
|
|
{
|
|
delete &let_drNewToken;
|
|
return;
|
|
}
|
|
|
|
DT_TextToken *
|
|
pText = dynamic_cast< DT_TextToken* >(&let_drNewToken);
|
|
if (pText != 0)
|
|
{
|
|
sCurAtSeeType_byXML
|
|
<< pText->GetText();
|
|
pCurAtTag->SetName(sCurAtSeeType_byXML.c_str());
|
|
}
|
|
else
|
|
{
|
|
pCurAtTag->SetName("? (no identifier found)");
|
|
}
|
|
sCurAtSeeType_byXML.reset();
|
|
delete &let_drNewToken;
|
|
fCurTokenAddFunction = &SapiDocu_PE::SetCurSeeAlsoAtTagLinkText_3;
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::SetCurSeeAlsoAtTagLinkText_3( DYN ary::info::DocuToken & let_drNewToken )
|
|
{
|
|
csv_assert(pCurAtTag);
|
|
|
|
if (let_drNewToken.IsWhiteOnly())
|
|
{
|
|
delete &let_drNewToken;
|
|
return;
|
|
}
|
|
|
|
/// Could emit warning, but don't because this parser is obsolete.
|
|
// Tok_XmlLink_BeginTag *
|
|
// pLinkEnd = dynamic_cast< Tok_XmlLink_EndTag* >(&let_drNewToken);
|
|
// if (pLinkEnd == 0)
|
|
// {
|
|
// warn_aboutMissingClosingTag();
|
|
// }
|
|
|
|
delete &let_drNewToken;
|
|
fCurTokenAddFunction = &SapiDocu_PE::AddDocuToken2CurAtTag;
|
|
}
|
|
|
|
|
|
|
|
void
|
|
SapiDocu_PE::SetCurSinceAtTagVersion( DYN ary::info::DocuToken & let_drNewToken )
|
|
{
|
|
csv_assert(pCurAtTag);
|
|
|
|
DT_TextToken * pToken = dynamic_cast< DT_TextToken* >(&let_drNewToken);
|
|
if (pToken == 0)
|
|
{
|
|
delete &let_drNewToken;
|
|
return;
|
|
}
|
|
|
|
char cFirst = *pToken->GetText();
|
|
const char cCiphersend = '9' + 1;
|
|
if ( autodoc::CommandLine::Get_().DoesTransform_SinceTag()
|
|
AND NOT csv::in_range('0', cFirst, cCiphersend) )
|
|
{
|
|
delete &let_drNewToken;
|
|
return;
|
|
}
|
|
|
|
pCurAtTag->AddToken(let_drNewToken);
|
|
fCurTokenAddFunction = &SapiDocu_PE::AddDocuToken2SinceAtTag;
|
|
}
|
|
|
|
void
|
|
SapiDocu_PE::AddDocuToken2SinceAtTag( DYN ary::info::DocuToken & let_drNewToken )
|
|
{
|
|
csv_assert(pCurAtTag);
|
|
|
|
DT_TextToken * pToken = dynamic_cast< DT_TextToken* >(&let_drNewToken);
|
|
if (pToken != 0)
|
|
{
|
|
String & sValue = pCurAtTag->Access_Text().Access_TextOfFirstToken();
|
|
StreamLock sHelp(1000);
|
|
sValue = sHelp() << sValue << pToken->GetText() << c_str;
|
|
}
|
|
else if (dynamic_cast< DT_White* >(&let_drNewToken) != 0)
|
|
{
|
|
String & sValue = pCurAtTag->Access_Text().Access_TextOfFirstToken();
|
|
StreamLock sHelp(1000);
|
|
sValue = sHelp() << sValue << " " << c_str;
|
|
}
|
|
|
|
delete &let_drNewToken;
|
|
}
|
|
|
|
const char *
|
|
AtTagTitle( const Tok_AtTag & i_rToken )
|
|
{
|
|
switch (i_rToken.Id())
|
|
{
|
|
case Tok_AtTag::author: return "";
|
|
case Tok_AtTag::see: return "See also";
|
|
case Tok_AtTag::param: return "Parameters";
|
|
case Tok_AtTag::e_return: return "Returns";
|
|
case Tok_AtTag::e_throw: return "Throws";
|
|
case Tok_AtTag::example: return "Example";
|
|
case Tok_AtTag::deprecated: return "Deprecated";
|
|
case Tok_AtTag::suspicious: return "";
|
|
case Tok_AtTag::missing: return "";
|
|
case Tok_AtTag::incomplete: return "";
|
|
case Tok_AtTag::version: return "";
|
|
case Tok_AtTag::guarantees: return "Guarantees";
|
|
case Tok_AtTag::exception: return "Exception";
|
|
case Tok_AtTag::since: return "Since version";
|
|
default:
|
|
// See below.
|
|
;
|
|
}
|
|
return i_rToken.Text();
|
|
}
|
|
|
|
|
|
|
|
} // namespace dsapi
|
|
} // namespace csi
|
|
|