/**
 * @Программа: flangdoc.fln
 * @Версия:0.1 (draft)
 * @Автор: А.В. Манцивода
 * @Дата начала разработки: 12-10-2003
 * @Дата последнего изменения: 14-10-2003
 * @Описание: Программа автоматически формирует информацию о встроенных
 * функциях Флэнга в стиле JavaDoc на основе xml-описания встроенных
 * функций, подготовленных в системе Мета-1 (файл flangdoc.xml).
 * @Использование: Запустить программу и вызвать функцию main().
 *
 * @Точка входа: main()
 */

main() :-
    contents := newVector(0),
    createChaptersPages(^chapEnum),
    createContents(),
    writeHTML("abc.html", genABC(^wholeList), "w")
    ;

/* FUNCTIONS CHAPTER PAGES */

createChaptersPages(DocEnum) :-
        exhausted(DocEnum), !, true
        ;
createChaptersPages(DocEnum) :-
        Chapter = eValue(DocEnum),
        Title = getXText(Chapter, "/item/title"),
        ChapID = getXAttr(Chapter, "identifier"),
        FileName = ChapID+".html",
        pageName := FileName,
        Conts = <a href=_FileName;>_Title;</a>,
        vAdd(^contents, [Conts, <BR/>]),
        FuncEnum = eXElem(Chapter, "/item/item"),
        HTML = htmlPattern(createPage(FuncEnum, Title)),
        writeHTML(ChapID+".html", HTML, "w"),
        createChaptersPages(eNext(DocEnum))
        ;

createContents() :-
        writeHTML("fldocConts.html", htmlPattern([createHeader("Встроенные функции Флэнга", "", ""), ^contents]), "w");

createPage(FuncEnum, Title) :-
 overviewTab := newVector(0),
 FunCollection = collectFunc(FuncEnum),
 [
 createHeader(Title, "", "")
 ,
 <div>
    <p>
        _overviewTable(^overviewTab);
    </p>
    <p>
      <TABLE cellSpacing="0" cellPadding="3" width="100%" border="1">
        <TBODY>
          <TR class="TableHeadingColor" bgColor="#ccccff">
          <TD><FONT size="+2"><B>Описание функций</B></FONT>
          </TD></TR>
        </TBODY>
      </TABLE>
    </p>

  _FunCollection;
 </div>
 ]
    ;

overviewTable(Conts) :-
    <TABLE cellSpacing="0" cellPadding="3" width="100%" border="1">
        <TBODY>
            <TR class="TableHeadingColor" bgColor="#ccccff">
                <TD colSpan="2"><FONT size="+2"><B>Обзор функций</B></FONT></TD>
            </TR>
            _Conts;
        </TBODY>
    </TABLE>
    ;

overviewItem(FunctionType, FuncCall, Descr) :-
    <TR class="TableRowColor" bgColor="white">
        <TD vAlign="top" align="right" width="1%">
            <FONT size="-1">
                <CODE>_FunctionType;</CODE>
            </FONT>
        </TD>
        <TD><CODE><B>_FuncCall;</B></CODE><BR/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_sNorm(Descr);
        </TD>
    </TR>
    ;

collectFunc(Enum) :- exhausted(Enum), !, [];
collectFunc(Enum) :-
        El1 = eValue(Enum),
        ID = getXAttr(El1, "identifier"),
        (
             El = isIDREF(ID) /* reference to another description, has the form "ID-IDREF" */
          ## El = El1
         ),
        [functionDescr(El) | collectFunc(eNext(Enum))];

/* FUNCTION DESCRIPTION */
functionDescr(FuncArticle):-
    ID = getXAttr(FuncArticle, "identifier"),
    Name = getXText(FuncArticle, "/item/title"),
    DetailFile = ID+".html",
    DetailsLink = "detail/"+DetailFile,
    writeHTML(DetailsLink, underConstruction(Name), "w"),
    ArgsEnum = eXElem(FuncArticle, "/item/metadata/lom/general/Arguments"),
    ArgList = functionArgList(ArgsEnum),
    write(Name+nl()),
    FT = getXText(FuncArticle, "/item/metadata/lom/general/ResultType"),
    FuncType = functionType(FT),
    FunCall = functionCall(Name, FuncType, ArgList),
    FunDescr = getXText(FuncArticle, "/item/metadata/lom/general/FunDescr"),
    Notes = getXText(FuncArticle, "/item/metadata/lom/general/Notes"),
    vAdd(^overviewTab, overviewItem(FuncType, funcOverviewCall(Name, ArgList, "#"+ID), FunDescr)),
    hPut(^wholeList, Name, ^pageName+"#"+ID),
    FunctionArgumentList =
        foreach X in ArgList
        [
            [_, Var, Des] = X,
            functionArgument(Var, Des)
        ],

    <DIV>
        <A name=_ID;>_"";</A>
        <H3>_Name;</H3>
        _FunCall;
        <DL>
            <DD>_FunDescr+" "+Notes;</DD>
                <P></P>
            <DT><B>Аргументы:</B></DT>
                _FunctionArgumentList;
            <DT><a href=_DetailsLink;><B>Подробнее...</B></a> </DT>
        </DL>
        <HR/>
    </DIV>
    ;

functionArgList(ArgEnum) :-
    ArgVector =
        foreach Arg in ArgEnum
        [
            Name  = getXText(Arg, "/Arguments/Argument"),
            Type  = getXText(Arg, "/Arguments/Type"),
            Descr = getXText(Arg, "/Arguments/Desription"),
            [functionType(Type), Name, Descr]
        ],
    vToL(enum(ArgVector));


/* формат вызова функции в статье */
functionCall(FunName, FunType, ArgList) :-
    Pos = sIndexOf(FunName, "/"),
    Pos>>0, !,
    ShortName = subString(FunName, 0, Pos),
    <PRE>
_[FunType," "];_ShortName;(_showArgs(ArgList);)
    </PRE>
    ;
/* infix */
functionCall(FunName, FunType, [[T1, N1, _], [T2, N2, _]]) :-
    <PRE>
_[FunType," (", T1, ")", N1, " ", FunName, " (", T2, ")", N2];
    </PRE>
    ;
/* prefix */
functionCall(FunName, FunType, [[T1, N1, _]]) :-
    <PRE>
_[FunType, " ", FunName, "(", T1, ")", N1];
    </PRE>
    ;

/* constant */
functionCall(FunName, FunType, []) :-
    <PRE>
_[FunType, " ", FunName];
    </PRE>
    ;


/* формат вызова функции в обзорной таблице */
funcOverviewCall(FunName, ArgList, Ref) :-
    Pos = sIndexOf(FunName, "/"),
    Pos>>0, !,
    ShortName = subString(FunName, 0, Pos),
    <SPAN>
<a href=_Ref;>_ShortName;</a>(_showArgs(ArgList);)
    </SPAN>
    ;
/* infix */
funcOverviewCall(FunName, [[T1, N1, _], [T2, N2, _]], Ref) :-
    <SPAN>
_["(", T1, ")", N1, " ", <a href=_Ref;>_FunName;</a>, " (", T2, ")", N2];
    </SPAN>
    ;
/* prefix */
funcOverviewCall(FunName, [[T1, N1, _]], Ref) :-
    <SPAN>
_[<a href=_Ref;>_FunName;</a>, "(", T1, ")", N1];
    </SPAN>
    ;
/* constant */
funcOverviewCall(FunName, [], Ref) :-
    <SPAN>
_[<a href=_Ref;>_FunName;</a>];
    </SPAN>
    ;

showArgs([]) :- !, "";
showArgs([[Type, Name, _]]) :- !, [Type, " ", Name];
showArgs([[Type, Name, _] | Rest]) :- [Type, " ", Name+", " | showArgs(Rest)];

functionType(Type) :-
    Pos = sIndexOf(Type, "/"),
    Pos>>0, !,
    Type1 = subString(Type, 0, Pos),
    Rest = subString(Type, Pos+1, sLength(Type)),
    TypeLink = hGet(^typesHash, Type1),
    [<a href=_TypeLink;>_Type1;</a>, "/" | functionType(Rest)]
    ;
functionType(Type) :-
    TypeLink = hGet(^typesHash, Type),
    [<a href=_TypeLink;>_Type;</a>]
    ;

/* Формат описания переменной для функции */
functionArgument(Variable, Descr) :-
    <DD>
        <CODE>_Variable;</CODE>
        -  _Descr;
    </DD>
    ;

argumentInCall(ArgName, ArgType) :- 1;

/* GENERATE ABC */

genABC(H) :-
    List = vToL(eKeys(H)),
    Sorted = qsort(List),
    Conts = genABChtml(Sorted, H),
    <html>
        <head>
            <title>Флэнг. Встроенные функции</title>
            <link rel="stylesheet" type="text/css" href="stylesheet.css"/>
        </head>
        <body>
            <h4>Функции по алфавиту</h4>
            _Conts;
        </body>
    </html>
    ;

genABChtml([], H) :- [];
genABChtml([X|Y], H) :-
    [<a href=_hGet(H, X); target="classFrame">_X;</a>, <br/> | genABChtml(Y, H)];

/* PARAMETERS AND ACCESS FUNCTIONS*/
/* загружаем XML-документ с описанием Флэнга */
?- document := readXML("flangdoc.xml", "w");

/* выделяем блок организаций "встроенные функции Флэнга" */
?- builtins:=getXElem(^document,"//organization[@identifier='builtins']");

/* организуем перечисление по главам блока встроенных функций */
?- chapEnum:= eXElem(^builtins, "/organization/item");

/* хэш для коллекционирования полного списка функций */
?- wholeList := newHash([]);

/* создаем таблицу типов данных с линками на информацию о типах */
typesHashCreate():-
    typesHash := newHash(
        [
            "Hash"/"./types/hash.html",
            "Vector"/"./types/vector.html",
            "Integer"/"./types/Integer.html",
            "Float"/"./types/float.html",
            "Enumeration"/"./types/enum.html",
            "List"/"./types/list.html",
            "Object"/"./types/object.html",
            "Boolean"/"./types/boolean.html",
            "String"/"./types/string.html"
        ])
    ;
?- typesHashCreate();

getFunctionsEnum(Chapter) :-
        eXElem(Chapter, "/item/item")
        ;

/* vToL формирует элементы перечисления в виде списка */
vToL(Enum) :- exhausted(Enum), !, [];
vToL(Enum) :- El = eValue(Enum), [El|vToL(eNext(Enum))];

htmlPattern(Conts) :-
    <html>
        <head>
            <title>Флэнг. Встроенные функции</title>
            <link rel="stylesheet" type="text/css" href="stylesheet.css"/>
        </head>
        <body>
            _Conts;
        </body>
    </html>
    ;

createHeader(Title, Back, Forward) :-
[
<TABLE cellSpacing="0" cellPadding="1" width="100%" border="0">
  <TBODY>
  <TR>
    <TD class="NavBarCell1" bgColor="#eeeeff" colSpan="3"><A
      name="navbar_top_firstrow">_"";</A>
      <TABLE cellSpacing="3" cellPadding="0" border="0">
        <TBODY>
        <TR vAlign="top" align="middle">
          <TD class="NavBarCell1" bgColor="#eeeeff"><A href="underConstruction.html"><FONT class="NavBarFont1"><B>Обзор</B></FONT></A>&nbsp;</TD>
          <TD class="NavBarCell1" bgColor="#eeeeff"><A href="underConstruction.html"><FONT class="NavBarFont1"><B>Типы данных</B></FONT></A>&nbsp;</TD>
          <TD class="NavBarCell1Rev" bgColor="#ffffff">&nbsp;<FONT class="NavBarFont1Rev"><B>Функции</B></FONT>&nbsp;</TD>
          <TD class="NavBarCell1" bgColor="#eeeeff"><A href="underConstruction.html"><FONT class="NavBarFont1"><B>Примеры</B></FONT></A>&nbsp;</TD>
          <TD class="NavBarCell1" bgColor="#eeeeff"><A href="underConstruction.html"><FONT class="NavBarFont1"><B>Подробно...</B></FONT></A>&nbsp;</TD>
        </TR>
        </TBODY>
       </TABLE>
    </TD>
    <TD vAlign="top" align="right" rowSpan="3"><EM></EM></TD>
  </TR>
  <TR>
    <TD class="NavBarCell2" bgColor="white"><FONT size="-2">&nbsp;
      <A href="fldocConts.html" target="classFrame"><B>ОГЛАВЛЕНИЕ</B></A></FONT>
    </TD>

    </TR>
  </TBODY>
</TABLE>
,
<HR/>
,
<H2><FONT size="-1">Встроенные функции Флэнга</FONT> <BR/>_Title;</H2>
,
<HR/>
,
<p/>
,
<p/>
]
;

under1Construction(Fun) :-
  <html>
    <head></head>
    <body>
      <b>Подробная информация по функции <code>'_Fun;'_" ";</code>
      разрабатывается</b>
    </body>
  </html>
  ;

underConstruction(Fun) :-
<html>
  <head><title>Flang Page Under Construction</title>
    <link rel="stylesheet" type="text/css" href="stylesheet.css"/>
    <meta http-equiv="Content-Type" content="text/html; charset=windows-1251"/>
  </head>
    <body>
<table width="600">
<tr>
<td>
<h1><font>Подробное описание функции '_Fun;'_" "; разрабатывается</font></h1>
</td>
</tr>
<tr><td>
flang@teaCode.com
</td></tr></table>
    </body>
</html>
;


/* СОРТИРОВКА */
qsort(List) :- qsort(List, Res, []), !, Res;

qsort([X|L], R, R0) :-
        partition(L, X, L1, L2),
        qsort(L2, R1, R0),
        qsort(L1, R, [X|R1])
        ;
qsort([], R, R);

partition([X|L],Y, Res1, Res2) :-
        X <= Y,
        Res1 = [X|L1],
        partition(L,Y,L1,Res2)
     ##
        Res2 = [X|L2],
        partition(L,Y,Res1,L2)
        ;

partition([],X,[],[]);

/* description reference check */
isIDREF(Str) :- sMatch("/(\w+)-IDREF/", Str), getByREF(sGroup(1));
getByREF(Str) :- XPath = "//item[@identifier='"+Str+"']", getXElem(^builtins, XPath);
/* getByREF(Str) :- XPath = "//item", getXElem(^builtins, "//item"); */


/************* ОТЛАДОЧНЫЕ ФУНКЦИИ ***********/
?- f:=getFunctionsEnum(eValue(^chapEnum));
t(X) :- trace("level", X);

w() :- writeHTML("ff.htm", functionDescr(eValue(^f)), "w");
w1() :- writeHTML("ff.htm", htmlPattern(createPage(^f)), "w");
w2() :- writeHTML("fff.htm", overviewTable(), "w");
w3() :- writeHTML("fff.htm", htmlPattern(createHeader("hehe", "haha", "hoho")), "w");
r() :- reload(fd);
?- defaultEnc("a");