[wxWidgets.git] / utils / HelpGen / src / docripper.cpp

/////////////////////////////////////////////////////////////////////////////
// Name:        No names yet.
// Purpose:     Contrib. demo
// Author:      Aleksandras Gluchovas
// Modified by:
// Created:     22/09/98
// RCS-ID:      $Id$
// Copyright:   (c) Aleskandars Gluchovas
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

// For compilers that support precompilation, includes "wx/wx.h".
#include "wx/wxprec.h"

#ifdef __BORLANDC__
#pragma hdrstop
#endif

#ifndef WX_PRECOMP
#include "wx/wx.h"
#endif

#include "docripper.h"

#if wxUSE_IOSTREAMH
    #include <iostream.h>
#else
    #include <iostream>
#endif

// script templates

// ***** currently only HTML versions of variouse templates available ***** //

static const char* HTM_TopTempl =

"<html><body bgcolor=#FFFFFF>\n\
\n\n<!------ Automatically Generated by \"wxDocRipper\"------->\n\n\n\
<p><h2>$(NAME)</h2><p>\n\
<ul>\n\
$(REFLIST)\
</ul><p>\n\n\
";

static const char* HTM_ContentIdxTempl =

"\
<a name=\"r$(ID)_$(NAME)\">\n\
<p><hr>\n\
<h2><p>$(NAME)<p></h2>\
<ul>\n\
$(REFLIST)\
</ul><p>\n\n\
";

static const char* HTM_SuperContentTempl =

"\
<a name=\"r$(ID)_$(NAME)\">\n\
<p><hr>\n\
<p><h2>$(NAME)<p></h2>\
$(BODY)\n\
";

static const char* HTM_SubContentTempl =

"\
<a name=\"r$(ID)_$(NAME)\">\n\
<p><hr>\n\
<p><h3>$(NAME)<p></h3>\
$(BODY)\n\
";

static const char* HTM_OutLineTempl =

"\
<p>\n\
<b><font color=\"#FF0000\">$(NAME)</font></b><p>\n\
";

static const char* HTM_OutLine1Templ =

"\
<p>\n\
<b><i><font color=\"#101010\">$(NAME)</font></i></b>\n\
<ul>\n\
$(REFLIST)\
</ul>\n\n\
";

static const char* HTM_RefTempl =

"\
<li><a href=\"#r$(ID)_$(NAME)\">$(NAME)</A>\n\
";

static const char* HTM_DeadRefTempl =

"\
<li></b>$(NAME)\n\
";

/***** Implementation for class RipperDocGen *****/

RipperDocGen::RipperDocGen()

    : mTopTempl         ( HTM_TopTempl ),
      mContentIdxTempl  ( HTM_ContentIdxTempl ),
      mSuperContentTempl( HTM_SuperContentTempl ),
      mSubContentTempl  ( HTM_SubContentTempl ),
      mOutLineTempl     ( HTM_OutLineTempl ),
      mOutLine1Templ    ( HTM_OutLine1Templ ),

      mRefTempl         ( HTM_RefTempl ),
      mDeadRefTempl     ( HTM_DeadRefTempl ),

      mpCurClassSect(0)
{
    // topIndex is not referenced
    mpTopIdx        = new ScriptSection( "Source Code Contents"       , "", &mTopTempl       , 0          );
    mpClassIdx      = new ScriptSection( "Classes Reference"          , "", &mContentIdxTempl, &mRefTempl );
    mpEnumIdx       = new ScriptSection( "Enumerations  Reference"    , "", &mContentIdxTempl,  &mRefTempl );
    mpTypeDefIdx    = new ScriptSection( "Type Definitions Reference" , "", &mContentIdxTempl, &mRefTempl );
    mpMacroIdx      = new ScriptSection( "Macros Reference"           , "", &mContentIdxTempl, &mRefTempl );
    mpGlobalVarsIdx = new ScriptSection( "Global Variables Reference" , "", &mContentIdxTempl, &mRefTempl );
    mpGlobalFuncIdx = new ScriptSection( "Global Functions  Reference", "", &mContentIdxTempl, &mRefTempl );
    mpConstIdx      = new ScriptSection( "Constants  Reference"       , "", &mContentIdxTempl, &mRefTempl );

    // assemble top index
    mpTopIdx->AddSection( mpClassIdx     , 1 );
    mpTopIdx->AddSection( mpEnumIdx      , 1 );
    mpTopIdx->AddSection( mpTypeDefIdx   , 1 );
    mpTopIdx->AddSection( mpMacroIdx     , 1 );
    mpTopIdx->AddSection( mpGlobalVarsIdx, 1 );
    mpTopIdx->AddSection( mpGlobalFuncIdx, 1 );
    mpTopIdx->AddSection( mpConstIdx     , 1 );

    // register reserved variables for index and description templates
    ScriptSection::RegisterTemplate( mTopTempl );
    ScriptSection::RegisterTemplate( mContentIdxTempl );
    ScriptSection::RegisterTemplate( mSuperContentTempl );
    ScriptSection::RegisterTemplate( mSubContentTempl );
    ScriptSection::RegisterTemplate( mOutLineTempl );
    ScriptSection::RegisterTemplate( mOutLine1Templ );
    ScriptSection::RegisterTemplate( mRefTempl );
    ScriptSection::RegisterTemplate( mDeadRefTempl );

    // create the top-most (interfile) context
    mpFileBinderCtx = new spFile();

    // the default script is HTML
    mTags = get_HTML_markup_tags();

    mpParser = 0; // no default parser!
}

void RipperDocGen::Init( SourceParserBase* pParser )
{
    mpParser = pParser;
}

RipperDocGen::~RipperDocGen()
{
    delete mpFileBinderCtx;
}

void RipperDocGen::AppendComments( spContext& fromContext, string& str )
{
    if ( !fromContext.HasComments() ) return;

    size_t start = str.length();

    str += mTags[TAG_BOLD].end;
    str += mTags[TAG_PARAGRAPH].start;

    MCommentListT& lst = fromContext.GetCommentList();

    for( size_t i = 0; i != lst.size(); ++i )
    {

        if ( i != 0 )

            if ( lst[i]->StartsParagraph() )
            {
                str += mTags[TAG_PARAGRAPH].start;
            }

        str += lst[i]->mText;
    }

    // remove new lines, and insert paragraph breaks

    // if empty lines found

    size_t len = str.length();

    for( size_t n = start; n != len; ++n )

        if ( str[n] == 10 ||
             str[n] == 13  )
        {
            if ( n + 2 < len )
            {
                if ( ( str[n] == 13 && str[n+1] == 10 &&  // FIXME:: quick-hack
                       str[n+2] == 13 ) ||
                     ( str[n] == 10 && str[n+1] == 10 )
                   )
                {
                    str.insert( n + 1, "<p>" ); // FIXME:: quick-hack
                    len += 3;
                }
            }
            str[n] = ' ';
        }
    str += mTags[TAG_PARAGRAPH].end;
}

void RipperDocGen::AppendMulitilineStr( string& st, string& mlStr )
{
    st = mTags[TAG_FIXED_FONT].start;
    st += mlStr;
    st += mTags[TAG_FIXED_FONT].end;
}

void RipperDocGen::AppendHighlightedSource( string& st, string source )
{
    // FIXME:: below should not be fixed :)
    char buf[1024*32];

    // DBG:::
//    ASSERT( source.length() + 1 < sizeof(buf) );

    strcpy( buf, source.c_str() );

    // highlight things
    mSrcPainter.Init();
    mSrcPainter.ProcessSource( buf, strlen(buf) );
    mSrcPainter.GetResultString( st, mTags );
}

bool RipperDocGen::CheckIfUncommented( spContext& ctx, ScriptSection& toSect )
{
    if ( ctx.HasComments() ) return 0;

    toSect.AddReference(
        new ScriptSection( GetScopedName( ctx ), "", 0, &mDeadRefTempl )
    );

    return 1;
}

ScriptTemplate* RipperDocGen::GetRefTemplFor( spContext& ctx )
{
    if ( ctx.HasComments() )
        return &mRefTempl;
    else
        return &mDeadRefTempl;
}

string RipperDocGen::GetScopedName( spContext& ofCtx )
{
    if ( ofCtx.IsInFile() )
        return ofCtx.GetName();
    else
        return ofCtx.GetOutterContext()->GetName() +
               "::" + ofCtx.GetName();
}

void RipperDocGen::AddToCurrentClass( ScriptSection* pSection, spContext& ctx,
                                      const char* subSectionName )
{
    string sName;

    if ( ctx.mVisibility == SP_VIS_PROTECTED )
        sName = "Protected members/";
    else
        if ( ctx.mVisibility == SP_VIS_PRIVATE )
            sName = "Private members/";
        else
            sName = "Public members/";

    sName += subSectionName;

    ScriptSection* pSect = mpCurClassSect->GetSubsection( sName.c_str() );

    if ( CheckIfUncommented( ctx, *pSect ) )
    {
        delete pSection;
        return;
    }

    pSect->AddReference( pSection );

    mpCurClassSect->AddSection( pSection );
}

void RipperDocGen::LinkSuperClassRefs()
{
    MMemberListT clLst;

    // collect all classes in the context tree
    mpFileBinderCtx->GetContextList( clLst, SP_CTX_CLASS );

    for( size_t i = 0; i != clLst.size(); ++i )
    {
        spClass& cl = *((spClass*)clLst[i]);

        // FIXME:: why sometimes GetUserData() returns NULL?
        if ( !cl.GetUserData() )
            continue;

        ScriptSection* pClSect = (ScriptSection*)cl.GetUserData();
        ScriptSection* pSuperSect = pClSect->GetSubsection("Derived from");

        for( size_t n = 0; n != cl.mSuperClassNames.size(); ++n )
        {
            string& superClName = cl.mSuperClassNames[n];

            spClass* pFound = NULL;

            for( size_t k = 0; k != clLst.size(); ++k )
            {
                if ( clLst[k]->GetName() == superClName )
                {
                    pFound = (spClass*)clLst[k];
                    break;
                }
            }

            if ( !pFound )
            {
                ScriptSection* pNotFound =
                    new ScriptSection( superClName, "", 0, &mDeadRefTempl );

                pSuperSect->AddReference( pNotFound );
            }
            else
                if ( pFound->GetUserData() )

                    pSuperSect->AddReference(
                        (ScriptSection*)pFound->GetUserData() );
        }
    }
}

void RipperDocGen::ProcessFile( const char* sourceFile )
{
    wxSTD cout << "Processing file " << sourceFile << "..." << wxSTD endl;

    spFile* pCtx = mpParser->ParseFile( sourceFile );

    if ( pCtx == NULL )
    {
        wxSTD cout << "Cannot open file " << sourceFile << ", skipped..." << wxSTD endl;

        return;
    }

    VisitAll( *pCtx, true );

    mpFileBinderCtx->AddMember( pCtx );
}

// implementations of "visiting procedures"

void RipperDocGen::VisitEnumeration( spEnumeration& en )
{
    // FOR NOW:: do not reference "nameless" enums
    if ( en.GetName() == "" ) return;

    if ( CheckIfUncommented( en, *mpEnumIdx ) )
        return;

    string body;
    body += mTags[TAG_BOLD].start;

    AppendMulitilineStr( body, en.mEnumContent );

    body += mTags[TAG_BOLD].end;

    string line;
    AppendHighlightedSource( line, body );
    AppendComments( en, line );

    mpEnumIdx->AddSection(
        new ScriptSection( en.GetName(), line,
                           &mSubContentTempl,
                           GetRefTemplFor( en ) ), 1
    );
}

void RipperDocGen::VisitTypeDef( spTypeDef& td )
{
    if ( CheckIfUncommented( td, *mpTypeDefIdx ) )
        return;

    string body;
    body += mTags[TAG_BOLD].start;
    body += "typdef ";
    body += mTags[TAG_BOLD].end;

    AppendMulitilineStr( body, td.mOriginalType );
    body += td.mOriginalType;
    body += ' ';

    body += mTags[TAG_BOLD].start;
    body += td.GetName();
    body += mTags[TAG_BOLD].end;

    string line;
    AppendHighlightedSource( line, body );
    AppendComments( td, line );

    mpTypeDefIdx->AddSection(
        new ScriptSection( td.GetName(), line,
                           &mSubContentTempl,
                           GetRefTemplFor( td ) ), true
    );
}

void RipperDocGen::VisitPreprocessorLine( spPreprocessorLine& pd )
{
    if ( pd.mDefType != SP_PREP_DEF_REDEFINE_SYMBOL )
        return;

    if ( CheckIfUncommented( pd, *mpMacroIdx ) )
        return;

    string body;
    body += mTags[TAG_FIXED_FONT].start;

    string coloredLine = pd.mLine;
    AppendHighlightedSource( coloredLine, pd.mLine );

    AppendMulitilineStr( body, coloredLine );

    body += mTags[TAG_FIXED_FONT].end;

    AppendComments( pd, body );

    mpMacroIdx->AddSection(
        new ScriptSection( pd.GetName(), body,
                           &mSubContentTempl,
                           GetRefTemplFor( pd ) ), true
    );
}

void RipperDocGen::VisitClass( spClass& cl )
{
    // FOR NOW:: do not document nested classes -
    //           nicier visiting method yet needed

    if ( cl.IsInClass() )
    {
        SkipChildren(); // spVisitor's method
        return;
    }

    string body;
    AppendComments( cl, body );

    mpCurClassSect =
        new ScriptSection( cl.GetName(), body, &mSuperContentTempl, &mRefTempl );

    // set up reference in the class context, pointing back
    // to the section where this class is represented
    cl.SetUserData( mpCurClassSect );

    ScriptSection* pSuper    = new ScriptSection( "Derived from"    ,"", &mOutLine1Templ,0, 1 );

    ScriptSection* pPublic    = new ScriptSection( "Public members"    ,"", &mOutLineTempl,0, 1 );
    ScriptSection* pProtected = new ScriptSection( "Protected members" ,"", &mOutLineTempl,0, 1 );
    ScriptSection* pPrivate   = new ScriptSection( "Private members"   ,"", &mOutLineTempl,0, 1 );

    pPublic->AddSection( new ScriptSection( "Operations", "", &mOutLine1Templ, 0, 1 ) );
    pPublic->AddSection( new ScriptSection( "Attributes", "", &mOutLine1Templ, 0, 1 ) );

    pProtected->AddSection( new ScriptSection( "Operations", "", &mOutLine1Templ, 0, 1 ) );
    pProtected->AddSection( new ScriptSection( "Attributes", "", &mOutLine1Templ, 0, 1 ) );

    pPrivate->AddSection( new ScriptSection( "Operations", "", &mOutLine1Templ, 0, 1 ) );
    pPrivate->AddSection( new ScriptSection( "Attributes", "", &mOutLine1Templ, 0, 1 ) );

    mpCurClassSect->AddSection( pSuper    );
    mpCurClassSect->AddSection( pPublic    );
    mpCurClassSect->AddSection( pProtected );
    mpCurClassSect->AddSection( pPrivate   );

    mpClassIdx->AddSection( mpCurClassSect, true );
}

void RipperDocGen::VisitAttribute( spAttribute& attr )
{
    string body;
    body += mTags[TAG_BOLD].start;
    body += attr.mType;
    body += mTags[TAG_BOLD].end;

    body += mTags[TAG_ITALIC].start;
    body += ' ';
    body += attr.GetName();
    body += mTags[TAG_ITALIC].end;

    string line;
    AppendHighlightedSource( line, body );
    AppendComments( attr, line );

    ScriptSection* pSection =
        new ScriptSection( GetScopedName( attr ), line,
                           &mSubContentTempl,
                           GetRefTemplFor( attr ) );

    if ( attr.mIsConstant )
        mpConstIdx->AddSection( pSection, true );
    else
        if ( !attr.IsInClass() )
        {
            if ( CheckIfUncommented( attr, *mpGlobalVarsIdx ) )
                return;
            mpGlobalVarsIdx->AddSection( pSection, true );
        }
        else
            AddToCurrentClass( pSection, attr, "Attributes" );
}

void RipperDocGen::VisitOperation( spOperation& op )
{
    string body;

    AppendHighlightedSource( body, op.GetFullName(mTags) );

    AppendComments( op, body );

    ScriptSection* pSection =
        new ScriptSection( GetScopedName( op ), body,
                           &mSubContentTempl,
                           GetRefTemplFor( op ) );

    if ( !op.IsInClass() )
    {
        if ( CheckIfUncommented( op, *mpGlobalFuncIdx ) )
            return;

        mpGlobalFuncIdx->AddSection( pSection, 1 );
    }
    else
        AddToCurrentClass( pSection, op, "Operations" );
}

bool RipperDocGen::OnSaveDocument( ScriptStream& WXUNUSED(stm) )
{
    LinkSuperClassRefs();

    // FOR NOW:: doesn't work yet
    //mpTopIdx->RemoveEmptySections();

    return 1; // saving can proceed now
}
Commit	Line	Data
cecfc5e7 VZ	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: No names yet.
	3	// Purpose: Contrib. demo
	4	// Author: Aleksandras Gluchovas
	5	// Modified by:
	6	// Created: 22/09/98
	7	// RCS-ID: $Id$
	8	// Copyright: (c) Aleskandars Gluchovas
8ad74db3	9	// Licence: wxWindows licence
cecfc5e7 VZ	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	// For compilers that support precompilation, includes "wx/wx.h".
	13	#include "wx/wxprec.h"
	14
	15	#ifdef __BORLANDC__
	16	#pragma hdrstop
	17	#endif
	18
	19	#ifndef WX_PRECOMP
	20	#include "wx/wx.h"
	21	#endif
	22
	23	#include "docripper.h"
	24
4888e623 GT	25	#if wxUSE_IOSTREAMH
	26	#include <iostream.h>
	27	#else
	28	#include <iostream>
	29	#endif
cecfc5e7 VZ	30
	31	// script templates
	32
	33	// *** currently only HTML versions of variouse templates available *** //
	34
8ad74db3	35	static const char* HTM_TopTempl =
cecfc5e7 VZ	36
	37	"<html><body bgcolor=#FFFFFF>\n\
	38	\n\n<!------ Automatically Generated by \"wxDocRipper\"------->\n\n\n\
	39	<p><h2>$(NAME)</h2><p>\n\
	40	<ul>\n\
	41	$(REFLIST)\
	42	</ul><p>\n\n\
	43	";
	44
8ad74db3	45	static const char* HTM_ContentIdxTempl =
cecfc5e7 VZ	46
	47	"\
	48	<a name=\"r$(ID)_$(NAME)\">\n\
	49	<p><hr>\n\
	50	<h2><p>$(NAME)<p></h2>\
	51	<ul>\n\
	52	$(REFLIST)\
	53	</ul><p>\n\n\
	54	";
	55
8ad74db3	56	static const char* HTM_SuperContentTempl =
cecfc5e7 VZ	57
	58	"\
	59	<a name=\"r$(ID)_$(NAME)\">\n\
	60	<p><hr>\n\
	61	<p><h2>$(NAME)<p></h2>\
	62	$(BODY)\n\
	63	";
	64
8ad74db3	65	static const char* HTM_SubContentTempl =
cecfc5e7 VZ	66
	67	"\
	68	<a name=\"r$(ID)_$(NAME)\">\n\
	69	<p><hr>\n\
	70	<p><h3>$(NAME)<p></h3>\
	71	$(BODY)\n\
	72	";
	73
	74	static const char* HTM_OutLineTempl =
	75
	76	"\
	77	<p>\n\
	78	<b><font color=\"#FF0000\">$(NAME)</font></b><p>\n\
	79	";
	80
	81	static const char* HTM_OutLine1Templ =
	82
	83	"\
	84	<p>\n\
	85	<b><i><font color=\"#101010\">$(NAME)</font></i></b>\n\
	86	<ul>\n\
	87	$(REFLIST)\
	88	</ul>\n\n\
	89	";
	90
	91	static const char* HTM_RefTempl =
	92
	93	"\
	94	<li><a href=\"#r$(ID)_$(NAME)\">$(NAME)</A>\n\
	95	";
	96
	97	static const char* HTM_DeadRefTempl =
	98
	99	"\
	100	<li></b>$(NAME)\n\
	101	";
	102
	103	/*** Implementation for class RipperDocGen ***/
	104
	105	RipperDocGen::RipperDocGen()
	106
8ad74db3 WS	107	: mTopTempl ( HTM_TopTempl ),
	108	mContentIdxTempl ( HTM_ContentIdxTempl ),
	109	mSuperContentTempl( HTM_SuperContentTempl ),
	110	mSubContentTempl ( HTM_SubContentTempl ),
	111	mOutLineTempl ( HTM_OutLineTempl ),
	112	mOutLine1Templ ( HTM_OutLine1Templ ),
	113
	114	mRefTempl ( HTM_RefTempl ),
	115	mDeadRefTempl ( HTM_DeadRefTempl ),
	116
	117	mpCurClassSect(0)
	118	{
	119	// topIndex is not referenced
	120	mpTopIdx = new ScriptSection( "Source Code Contents" , "", &mTopTempl , 0 );
	121	mpClassIdx = new ScriptSection( "Classes Reference" , "", &mContentIdxTempl, &mRefTempl );
	122	mpEnumIdx = new ScriptSection( "Enumerations Reference" , "", &mContentIdxTempl, &mRefTempl );
	123	mpTypeDefIdx = new ScriptSection( "Type Definitions Reference" , "", &mContentIdxTempl, &mRefTempl );
	124	mpMacroIdx = new ScriptSection( "Macros Reference" , "", &mContentIdxTempl, &mRefTempl );
	125	mpGlobalVarsIdx = new ScriptSection( "Global Variables Reference" , "", &mContentIdxTempl, &mRefTempl );
	126	mpGlobalFuncIdx = new ScriptSection( "Global Functions Reference", "", &mContentIdxTempl, &mRefTempl );
	127	mpConstIdx = new ScriptSection( "Constants Reference" , "", &mContentIdxTempl, &mRefTempl );
	128
	129	// assemble top index
	130	mpTopIdx->AddSection( mpClassIdx , 1 );
	131	mpTopIdx->AddSection( mpEnumIdx , 1 );
	132	mpTopIdx->AddSection( mpTypeDefIdx , 1 );
	133	mpTopIdx->AddSection( mpMacroIdx , 1 );
	134	mpTopIdx->AddSection( mpGlobalVarsIdx, 1 );
	135	mpTopIdx->AddSection( mpGlobalFuncIdx, 1 );
	136	mpTopIdx->AddSection( mpConstIdx , 1 );
	137
	138	// register reserved variables for index and description templates
	139	ScriptSection::RegisterTemplate( mTopTempl );
	140	ScriptSection::RegisterTemplate( mContentIdxTempl );
	141	ScriptSection::RegisterTemplate( mSuperContentTempl );
	142	ScriptSection::RegisterTemplate( mSubContentTempl );
	143	ScriptSection::RegisterTemplate( mOutLineTempl );
	144	ScriptSection::RegisterTemplate( mOutLine1Templ );
	145	ScriptSection::RegisterTemplate( mRefTempl );
	146	ScriptSection::RegisterTemplate( mDeadRefTempl );
	147
	148	// create the top-most (interfile) context
	149	mpFileBinderCtx = new spFile();
	150
	151	// the default script is HTML
	152	mTags = get_HTML_markup_tags();
	153
	154	mpParser = 0; // no default parser!
cecfc5e7 VZ	155	}
	156
	157	void RipperDocGen::Init( SourceParserBase* pParser )
	158	{
8ad74db3	159	mpParser = pParser;
cecfc5e7 VZ	160	}
	161
	162	RipperDocGen::~RipperDocGen()
	163	{
8ad74db3	164	delete mpFileBinderCtx;
cecfc5e7 VZ	165	}
	166
	167	void RipperDocGen::AppendComments( spContext& fromContext, string& str )
	168	{
8ad74db3	169	if ( !fromContext.HasComments() ) return;
4888e623	170
8ad74db3	171	size_t start = str.length();
4888e623	172
8ad74db3 WS	173	str += mTags[TAG_BOLD].end;
8ad74db3 WS	174	str += mTags[TAG_PARAGRAPH].start;
4888e623	175
8ad74db3	176	MCommentListT& lst = fromContext.GetCommentList();
4888e623	177
8ad74db3 WS	178	for( size_t i = 0; i != lst.size(); ++i )
8ad74db3 WS	179	{
4888e623	180
8ad74db3	181	if ( i != 0 )
4888e623	182
8ad74db3 WS	183	if ( lst[i]->StartsParagraph() )
	184	{
	185	str += mTags[TAG_PARAGRAPH].start;
	186	}
4888e623	187
8ad74db3 WS	188	str += lst[i]->mText;
8ad74db3 WS	189	}
4888e623	190
8ad74db3	191	// remove new lines, and insert paragraph breaks
4888e623	192
8ad74db3	193	// if empty lines found
cecfc5e7	194
8ad74db3	195	size_t len = str.length();
4888e623	196
8ad74db3	197	for( size_t n = start; n != len; ++n )
4888e623	198
8ad74db3 WS	199	if ( str[n] == 10 \|\|
	200	str[n] == 13 )
	201	{
	202	if ( n + 2 < len )
	203	{
	204	if ( ( str[n] == 13 && str[n+1] == 10 && // FIXME:: quick-hack
	205	str[n+2] == 13 ) \|\|
	206	( str[n] == 10 && str[n+1] == 10 )
	207	)
	208	{
	209	str.insert( n + 1, "<p>" ); // FIXME:: quick-hack
	210	len += 3;
	211	}
	212	}
	213	str[n] = ' ';
	214	}
	215	str += mTags[TAG_PARAGRAPH].end;
cecfc5e7 VZ	216	}
	217
	218	void RipperDocGen::AppendMulitilineStr( string& st, string& mlStr )
	219	{
8ad74db3 WS	220	st = mTags[TAG_FIXED_FONT].start;
	221	st += mlStr;
	222	st += mTags[TAG_FIXED_FONT].end;
cecfc5e7 VZ	223	}
	224
	225	void RipperDocGen::AppendHighlightedSource( string& st, string source )
	226	{
8ad74db3 WS	227	// FIXME:: below should not be fixed :)
	228	char buf[1024*32];
	229
	230	// DBG:::
	231	// ASSERT( source.length() + 1 < sizeof(buf) );
	232
	233	strcpy( buf, source.c_str() );
	234
	235	// highlight things
	236	mSrcPainter.Init();
	237	mSrcPainter.ProcessSource( buf, strlen(buf) );
	238	mSrcPainter.GetResultString( st, mTags );
cecfc5e7 VZ	239	}
	240
	241	bool RipperDocGen::CheckIfUncommented( spContext& ctx, ScriptSection& toSect )
	242	{
8ad74db3	243	if ( ctx.HasComments() ) return 0;
cecfc5e7	244
8ad74db3 WS	245	toSect.AddReference(
	246	new ScriptSection( GetScopedName( ctx ), "", 0, &mDeadRefTempl )
	247	);
cecfc5e7	248
8ad74db3	249	return 1;
cecfc5e7 VZ	250	}
	251
	252	ScriptTemplate* RipperDocGen::GetRefTemplFor( spContext& ctx )
	253	{
8ad74db3 WS	254	if ( ctx.HasComments() )
	255	return &mRefTempl;
	256	else
	257	return &mDeadRefTempl;
cecfc5e7 VZ	258	}
	259
	260	string RipperDocGen::GetScopedName( spContext& ofCtx )
	261	{
8ad74db3 WS	262	if ( ofCtx.IsInFile() )
	263	return ofCtx.GetName();
	264	else
	265	return ofCtx.GetOutterContext()->GetName() +
	266	"::" + ofCtx.GetName();
cecfc5e7 VZ	267	}
cecfc5e7 VZ	268
8ad74db3 WS	269	void RipperDocGen::AddToCurrentClass( ScriptSection* pSection, spContext& ctx,
8ad74db3 WS	270	const char* subSectionName )
cecfc5e7	271	{
8ad74db3	272	string sName;
cecfc5e7	273
8ad74db3 WS	274	if ( ctx.mVisibility == SP_VIS_PROTECTED )
	275	sName = "Protected members/";
	276	else
	277	if ( ctx.mVisibility == SP_VIS_PRIVATE )
	278	sName = "Private members/";
	279	else
	280	sName = "Public members/";
cecfc5e7	281
8ad74db3	282	sName += subSectionName;
cecfc5e7	283
8ad74db3	284	ScriptSection* pSect = mpCurClassSect->GetSubsection( sName.c_str() );
cecfc5e7	285
8ad74db3 WS	286	if ( CheckIfUncommented( ctx, *pSect ) )
	287	{
	288	delete pSection;
	289	return;
	290	}
cecfc5e7	291
8ad74db3	292	pSect->AddReference( pSection );
cecfc5e7	293
8ad74db3	294	mpCurClassSect->AddSection( pSection );
cecfc5e7 VZ	295	}
	296
	297	void RipperDocGen::LinkSuperClassRefs()
	298	{
8ad74db3 WS	299	MMemberListT clLst;
	300
	301	// collect all classes in the context tree
	302	mpFileBinderCtx->GetContextList( clLst, SP_CTX_CLASS );
	303
	304	for( size_t i = 0; i != clLst.size(); ++i )
	305	{
	306	spClass& cl = ((spClass)clLst[i]);
	307
	308	// FIXME:: why sometimes GetUserData() returns NULL?
	309	if ( !cl.GetUserData() )
	310	continue;
	311
	312	ScriptSection* pClSect = (ScriptSection*)cl.GetUserData();
	313	ScriptSection* pSuperSect = pClSect->GetSubsection("Derived from");
	314
	315	for( size_t n = 0; n != cl.mSuperClassNames.size(); ++n )
	316	{
	317	string& superClName = cl.mSuperClassNames[n];
	318
	319	spClass* pFound = NULL;
	320
	321	for( size_t k = 0; k != clLst.size(); ++k )
	322	{
	323	if ( clLst[k]->GetName() == superClName )
	324	{
	325	pFound = (spClass*)clLst[k];
	326	break;
	327	}
	328	}
	329
	330	if ( !pFound )
	331	{
	332	ScriptSection* pNotFound =
	333	new ScriptSection( superClName, "", 0, &mDeadRefTempl );
	334
	335	pSuperSect->AddReference( pNotFound );
	336	}
	337	else
	338	if ( pFound->GetUserData() )
	339
	340	pSuperSect->AddReference(
	341	(ScriptSection*)pFound->GetUserData() );
	342	}
	343	}
cecfc5e7 VZ	344	}
	345
	346	void RipperDocGen::ProcessFile( const char* sourceFile )
	347	{
8ad74db3	348	wxSTD cout << "Processing file " << sourceFile << "..." << wxSTD endl;
cecfc5e7	349
8ad74db3	350	spFile* pCtx = mpParser->ParseFile( sourceFile );
cecfc5e7	351
8ad74db3 WS	352	if ( pCtx == NULL )
	353	{
	354	wxSTD cout << "Cannot open file " << sourceFile << ", skipped..." << wxSTD endl;
cecfc5e7	355
8ad74db3 WS	356	return;
8ad74db3 WS	357	}
cecfc5e7	358
8ad74db3	359	VisitAll( *pCtx, true );
cecfc5e7	360
8ad74db3	361	mpFileBinderCtx->AddMember( pCtx );
cecfc5e7 VZ	362	}
	363
	364	// implementations of "visiting procedures"
	365
	366	void RipperDocGen::VisitEnumeration( spEnumeration& en )
	367	{
8ad74db3 WS	368	// FOR NOW:: do not reference "nameless" enums
8ad74db3 WS	369	if ( en.GetName() == "" ) return;
cecfc5e7	370
8ad74db3 WS	371	if ( CheckIfUncommented( en, *mpEnumIdx ) )
8ad74db3 WS	372	return;
cecfc5e7	373
8ad74db3 WS	374	string body;
8ad74db3 WS	375	body += mTags[TAG_BOLD].start;
cecfc5e7	376
8ad74db3	377	AppendMulitilineStr( body, en.mEnumContent );
cecfc5e7	378
8ad74db3	379	body += mTags[TAG_BOLD].end;
cecfc5e7	380
8ad74db3 WS	381	string line;
	382	AppendHighlightedSource( line, body );
	383	AppendComments( en, line );
cecfc5e7	384
8ad74db3 WS	385	mpEnumIdx->AddSection(
	386	new ScriptSection( en.GetName(), line,
	387	&mSubContentTempl,
	388	GetRefTemplFor( en ) ), 1
	389	);
cecfc5e7 VZ	390	}
	391
	392	void RipperDocGen::VisitTypeDef( spTypeDef& td )
	393	{
8ad74db3 WS	394	if ( CheckIfUncommented( td, *mpTypeDefIdx ) )
	395	return;
	396
	397	string body;
	398	body += mTags[TAG_BOLD].start;
	399	body += "typdef ";
	400	body += mTags[TAG_BOLD].end;
	401
	402	AppendMulitilineStr( body, td.mOriginalType );
	403	body += td.mOriginalType;
	404	body += ' ';
	405
	406	body += mTags[TAG_BOLD].start;
	407	body += td.GetName();
	408	body += mTags[TAG_BOLD].end;
	409
	410	string line;
	411	AppendHighlightedSource( line, body );
	412	AppendComments( td, line );
	413
	414	mpTypeDefIdx->AddSection(
	415	new ScriptSection( td.GetName(), line,
	416	&mSubContentTempl,
	417	GetRefTemplFor( td ) ), true
	418	);
cecfc5e7 VZ	419	}
	420
	421	void RipperDocGen::VisitPreprocessorLine( spPreprocessorLine& pd )
	422	{
8ad74db3 WS	423	if ( pd.mDefType != SP_PREP_DEF_REDEFINE_SYMBOL )
8ad74db3 WS	424	return;
cecfc5e7	425
8ad74db3 WS	426	if ( CheckIfUncommented( pd, *mpMacroIdx ) )
8ad74db3 WS	427	return;
4888e623	428
8ad74db3 WS	429	string body;
8ad74db3 WS	430	body += mTags[TAG_FIXED_FONT].start;
cecfc5e7	431
8ad74db3 WS	432	string coloredLine = pd.mLine;
8ad74db3 WS	433	AppendHighlightedSource( coloredLine, pd.mLine );
cecfc5e7	434
8ad74db3	435	AppendMulitilineStr( body, coloredLine );
cecfc5e7	436
8ad74db3	437	body += mTags[TAG_FIXED_FONT].end;
cecfc5e7	438
8ad74db3	439	AppendComments( pd, body );
cecfc5e7	440
8ad74db3 WS	441	mpMacroIdx->AddSection(
	442	new ScriptSection( pd.GetName(), body,
	443	&mSubContentTempl,
	444	GetRefTemplFor( pd ) ), true
	445	);
cecfc5e7 VZ	446	}
	447
	448	void RipperDocGen::VisitClass( spClass& cl )
	449	{
8ad74db3 WS	450	// FOR NOW:: do not document nested classes -
8ad74db3 WS	451	// nicier visiting method yet needed
cecfc5e7	452
8ad74db3 WS	453	if ( cl.IsInClass() )
	454	{
	455	SkipChildren(); // spVisitor's method
	456	return;
	457	}
cecfc5e7	458
8ad74db3 WS	459	string body;
8ad74db3 WS	460	AppendComments( cl, body );
cecfc5e7	461
8ad74db3 WS	462	mpCurClassSect =
8ad74db3 WS	463	new ScriptSection( cl.GetName(), body, &mSuperContentTempl, &mRefTempl );
cecfc5e7	464
8ad74db3 WS	465	// set up reference in the class context, pointing back
	466	// to the section where this class is represented
	467	cl.SetUserData( mpCurClassSect );
cecfc5e7	468
8ad74db3	469	ScriptSection* pSuper = new ScriptSection( "Derived from" ,"", &mOutLine1Templ,0, 1 );
cecfc5e7	470
8ad74db3 WS	471	ScriptSection* pPublic = new ScriptSection( "Public members" ,"", &mOutLineTempl,0, 1 );
	472	ScriptSection* pProtected = new ScriptSection( "Protected members" ,"", &mOutLineTempl,0, 1 );
	473	ScriptSection* pPrivate = new ScriptSection( "Private members" ,"", &mOutLineTempl,0, 1 );
cecfc5e7	474
8ad74db3 WS	475	pPublic->AddSection( new ScriptSection( "Operations", "", &mOutLine1Templ, 0, 1 ) );
8ad74db3 WS	476	pPublic->AddSection( new ScriptSection( "Attributes", "", &mOutLine1Templ, 0, 1 ) );
cecfc5e7	477
8ad74db3 WS	478	pProtected->AddSection( new ScriptSection( "Operations", "", &mOutLine1Templ, 0, 1 ) );
8ad74db3 WS	479	pProtected->AddSection( new ScriptSection( "Attributes", "", &mOutLine1Templ, 0, 1 ) );
cecfc5e7	480
8ad74db3 WS	481	pPrivate->AddSection( new ScriptSection( "Operations", "", &mOutLine1Templ, 0, 1 ) );
8ad74db3 WS	482	pPrivate->AddSection( new ScriptSection( "Attributes", "", &mOutLine1Templ, 0, 1 ) );
cecfc5e7	483
8ad74db3 WS	484	mpCurClassSect->AddSection( pSuper );
	485	mpCurClassSect->AddSection( pPublic );
	486	mpCurClassSect->AddSection( pProtected );
	487	mpCurClassSect->AddSection( pPrivate );
cecfc5e7	488
8ad74db3	489	mpClassIdx->AddSection( mpCurClassSect, true );
cecfc5e7 VZ	490	}
	491
	492	void RipperDocGen::VisitAttribute( spAttribute& attr )
	493	{
8ad74db3 WS	494	string body;
	495	body += mTags[TAG_BOLD].start;
	496	body += attr.mType;
	497	body += mTags[TAG_BOLD].end;
	498
	499	body += mTags[TAG_ITALIC].start;
	500	body += ' ';
	501	body += attr.GetName();
	502	body += mTags[TAG_ITALIC].end;
	503
	504	string line;
	505	AppendHighlightedSource( line, body );
	506	AppendComments( attr, line );
	507
	508	ScriptSection* pSection =
	509	new ScriptSection( GetScopedName( attr ), line,
	510	&mSubContentTempl,
	511	GetRefTemplFor( attr ) );
	512
	513	if ( attr.mIsConstant )
	514	mpConstIdx->AddSection( pSection, true );
	515	else
	516	if ( !attr.IsInClass() )
	517	{
	518	if ( CheckIfUncommented( attr, *mpGlobalVarsIdx ) )
	519	return;
	520	mpGlobalVarsIdx->AddSection( pSection, true );
	521	}
	522	else
	523	AddToCurrentClass( pSection, attr, "Attributes" );
cecfc5e7 VZ	524	}
	525
	526	void RipperDocGen::VisitOperation( spOperation& op )
	527	{
8ad74db3	528	string body;
cecfc5e7	529
8ad74db3	530	AppendHighlightedSource( body, op.GetFullName(mTags) );
cecfc5e7	531
8ad74db3	532	AppendComments( op, body );
cecfc5e7	533
8ad74db3 WS	534	ScriptSection* pSection =
	535	new ScriptSection( GetScopedName( op ), body,
	536	&mSubContentTempl,
	537	GetRefTemplFor( op ) );
cecfc5e7	538
8ad74db3 WS	539	if ( !op.IsInClass() )
	540	{
	541	if ( CheckIfUncommented( op, *mpGlobalFuncIdx ) )
	542	return;
cecfc5e7	543
8ad74db3 WS	544	mpGlobalFuncIdx->AddSection( pSection, 1 );
	545	}
	546	else
	547	AddToCurrentClass( pSection, op, "Operations" );
cecfc5e7 VZ	548	}
cecfc5e7 VZ	549
8ad74db3	550	bool RipperDocGen::OnSaveDocument( ScriptStream& WXUNUSED(stm) )
cecfc5e7	551	{
8ad74db3	552	LinkSuperClassRefs();
cecfc5e7	553
8ad74db3 WS	554	// FOR NOW:: doesn't work yet
8ad74db3 WS	555	//mpTopIdx->RemoveEmptySections();
cecfc5e7	556
8ad74db3	557	return 1; // saving can proceed now
cecfc5e7 VZ	558	}
cecfc5e7 VZ	559