path: root/modules/m2sci/macros/kernel/m2sci_syntax.sci

// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
// Copyright (C) ???? - INRIA - Scilab
// Copyright (C) 2002-2004 - INRIA - Vincent COUVERT
//
// This file must be used under the terms of the CeCILL.
// This source file is licensed as described in the file COPYING, which
// you should have received as part of this distribution.  The terms
// are also available at
// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt

function [helppart,txt,batch]=m2sci_syntax(txt)
    // Make minor changes on M-file data syntax to have it readable by Scilab
    // Input arguments:
    //  - txt: the contents of an M-file
    // Output:
    //  - helppart: Matlab help contained in M-file
    //  - txt: input txt modified (If M-file contains only comments returned txt is[])
    //  - batch: boolean flag indicates if it is a batch file

    // m2sci kernel functions called :
    //  - isacomment
    //  - isinstring
    //  - replace_brackets

    sciparam();
    quote="''"
    dquote=""""
    ctm="."+"."+"." // Continuation mark
    batch=%t

    k=0
    first_ncl=[]
    while k<size(txt,"r")
        k=k+1
        tk=txt(k)
        if part(stripblanks(tk),1:9) == "function " | part(stripblanks(tk),1:9) == "function[" then
            eolind=strindex(tk,";")
            if eolind<>[] then
                kc=isacomment(tk)
                if kc<>0 then // Current line has or is a comment
                    // If function prototype immediately followed by a comment on same line
                    if stripblanks(part(tk,eolind(1):kc))<>"" then
                        txt=[txt(1:k-1);part(tk,1:eolind(1)-1);part(tk,eolind(1)+1:length(tk));txt(k+1:size(txt,"*"))]
                        tk=part(tk,1:eolind(1)-1)
                    end
                elseif stripblanks(part(tk,eolind(1)+1:length(tk)))<>"" then
                    txt=[txt(1:k-1);part(tk,1:eolind(1)-1);part(tk,eolind(1)+1:length(tk));txt(k+1:size(txt,"*"))]
                    tk=part(tk,1:eolind(1)-1)
                end
            end
        end
    end

    // Number of lines in txt (i.e. in M-file)
    n=size(txt,"r")
    eoltoinsert=0
    firstctm=[]
    k=0
    while k<size(txt,"r")
        k=k+1
        kc=strindex(txt(k),ctm)
        isacontline=%f

        for kck=kc,
            kc1=isacomment(txt(k))
            if ~isinstring(txt(k),kck) then
                if kc1<>0 then // Line has a comment
                    if kc1<kck then // Continuation mark in a comment
                    else // Comment follow continuation mark
                        com=part(txt(k),kc1(1):length(txt(k)))
                        txt(k)=part(txt(k),1:kck-1)+txt(k+1)+com
                        txt(k+1)=[]
                        k=k-1
                        break
                    end
                else // Not a comment line
                    if isempty(firstctm) then firstctm=k;end
                    txt(k)=part(txt(k),1:kck-1)+txt(k+1)
                    txt(k+1)=[]
                    eoltoinsert=eoltoinsert+1
                    if isempty(strindex(txt(k),ctm)) then // If no ctm in txt(k), insert all necessary EOL to keep nblines unchanged
                        for l=0:eoltoinsert-1
                            txt=[txt(1:firstctm-1+l);"";txt(firstctm-1+l+1:$)]
                        end
                        eoltoinsert=0
                        firstctm=[]
                    end
                    k=k-1
                    break
                end
            end
        end
        if k<>0 then
            if part(stripblanks(txt(k)),1)=="}" then
                txt(k-1)=txt(k-1)+txt(k);
                txt(k)="";
            end
        end
    end

    // Change comments and get help part in input txt
    n=size(txt,"r")
    first=%t
    helppart=[],endofhelp=%f

    for k=1:n
        tk=txt(k)

        // ifthenelse expression like if (x==1)t=2 becomes if (x==1) t=2
        // Add a blank between parenthesize expression and the first instruction
        kif=strindex(tk,"if")
        if kif<>[] then
            kcom=isacomment(tk)
            for i=1:size(kif,"*")
                if kif(i)>kcom & kcom<>0 then
                    break
                else
                    if (kif(i)>1 & or(stripblanks(part(tk,kif(i)-1:kif(i)+2))==["if(","if"])) | (kif(i)==1 & or(stripblanks(part(tk,kif(i):kif(i)+2))==["if(","if"]))
                        m=min(strindex(tk,"("))
                        if m<>[] then
                            for l=1:size(m,"*")
                                if m(l)>=kif(i)+2
                                    if stripblanks(part(tk,kif(i)+2:m(l)))=="(" then
                                        openpar=1
                                        mtemp=m(l)+1
                                        while openpar<>0
                                            if or(part(tk,mtemp)=="(") then
                                                openpar=openpar+1
                                            elseif or(part(tk,mtemp)==")") then
                                                openpar=openpar-1
                                            end
                                            mtemp=mtemp+1
                                        end
                                        tk=part(tk,1:mtemp-1)+" "+part(tk,mtemp:length(tk))
                                        break
                                    end
                                end
                            end
                        end
                    end
                end
            end
        end

        // Insert a blank when a digit is followed by a dotted operator
        // So that point is associated to operator and not to digit
        // Because if it is associated to digit, dot is suppressed by comp()
        kdot=strindex(tk,[".*","./",".\",".^",".''"])
        if kdot<>[] then
            kdgt=kdot(find(abs(_str2code(part(tk,kdot-1)))<9))
            for kk=size(kdgt,"*"):-1:1
                tk=part(tk,1:kdgt(kk)-1)+" "+part(tk,kdgt(kk):length(tk));
            end
        end

        // Modify struct like x.(fieldname) which become x(fieldname)
        tk=strsubst(tk,".(","(")

        // Parenthesize calls to pause when pause on or pause off
        kpause=strindex(tk,"pause")
        kpsav=length(tk) // kpsave is kp value for l-1 index
        for l=size(kpause,"*"):-1:1
            kp=kpause(l)
            kon=strindex(tk,"on")
            kon=kon(find((kon>kp)&(kon<kpsav)))
            if kon<>[] then
                for l=kp+5:kon-1
                    if part(tk,l)<>" " then
                        break
                    end
                end
                tk=part(tk,1:kp+4)+"(''on'')"+part(tk,kon+2:length(tk))
            end
            koff=strindex(tk,"off")
            koff=koff(find((koff>kp)&(koff<kpsav)))
            if koff<>[] then
                for l=kp+5:koff-1
                    if part(tk,l)<>" " then
                        break
                    end
                end
                tk=part(tk,1:kp+4)+"(''off'')"+part(tk,koff+3:length(tk))
            end
            kpsav=kp
        end

        // Convert @fhandle to 'fhandle' (cf feval)
        symbs=[" ",",",";","=",")","]"]
        kpunct=strindex(tk,"@")
        kcom=isacomment(tk)
        if kcom<>0 then
            kpunct=kpunct(kpunct<kcom)
        end
        if kpunct<>[] then
            for l=size(kpunct,"*"):-1:1
                if ~isinstring(tk,kpunct(l)) then
                    kk=gsort(strindex(tk,symbs),"r","i")
                    kk=kk(find(kk>kpunct(l)))
                    if kk==[] then
                        kk=length(tk)
                        tk=part(tk,1:kpunct(l)-1)+quote+part(tk,kpunct(l)+1:kk)+quote
                    else
                        kk=kk(1)
                        tk=part(tk,1:kpunct(l)-1)+quote+part(tk,kpunct(l)+1:kk-1)+quote+part(tk,kk:length(tk))
                    end
                end
            end
        end

        // Looking for comments
        kc=isacomment(tk)
        if kc<>0 then // Current line has or is a comment
            // If function prototype immediately followed by a comment on same line
            if part(stripblanks(tk),1:9) == "function " | part(stripblanks(tk),1:9) == "function[" then
                first_ncl=k
            end
            com=part(tk,kc+1:length(tk))
            if stripblanks(part(tk,1:kc-1))<>"" &  ~(stripblanks(part(tk,1:9))=="function " | stripblanks(part(tk,1:9))=="function[")  then endofhelp=%t;end
            if ~endofhelp & part(tk,1:9) ~= "function " then helppart=[helppart;com];end // Get help part placed at the beginning of the file
            if length(com)==0 then com=" ",end
            com=strsubst(com,quote,quote+quote)
            com=strsubst(com,dquote,dquote+dquote)
            if part(com,1:12)=="m2sciassume " | part(com,1:13)=="m2scideclare " then // User has given a clue to help translation
                if part(com,1:12)=="m2sciassume " then
                    warning(gettext("m2sciassume is obsolete, used m2scideclare instead."));
                end
                com=";m2scideclare("+quote+part(com,13:length(com))+quote+")"
            else
                com=";//"+com
            end
            tkbeg=part(tk,1:kc-1)

            // Short circuiting operators
            if ~isempty(strindex(tkbeg,"||")) then
                orexpr=tokens(tkbeg,"|")
                boolendsymbol=%f
                orexprtemp=orexpr($)
                indendsymbol=strindex(orexpr($),[";",","])
                if indendsymbol<>[] then
                    if stripblanks(part(orexpr($),indendsymbol($)+1:length(orexpr($))))=="" then
                        boolendsymbol=%t
                        endsymbol=part(orexprtemp,indendsymbol($))
                        indendsymbol=indendsymbol($)
                        orexpr($)=part(orexpr($),1:indendsymbol($)-1)
                    end
                end
                for i=2:size(orexpr,"*")
                    notsymbol=strindex(stripblanks(orexpr(i)),"~")
                    if notsymbol<>[]
                        if notsymbol(1)==1 then
                            orexpr(i)="("+  stripblanks(orexpr(i)) + ")"
                        end
                    end
                end
                for kk=2:2:size(orexpr,"*")
                    orexpr=[orexpr(1:kk);"%shortcircuit";orexpr(kk+1:size(orexpr,"*"))]
                end
                tkbeg=strcat(orexpr,"|")
                if boolendsymbol then
                    tkbeg=tkbeg+endsymbol
                end
            end
            if ~isempty(strindex(tkbeg,"&&")) then
                andexpr=tokens(tkbeg,"&")
                boolendsymbol=%f
                andexprtemp=andexpr($)
                indendsymbol=strindex(andexpr($),[";",","])
                if indendsymbol<>[] then
                    if stripblanks(part(andexpr($),indendsymbol($)+1:length(andexpr($))))=="" then
                        boolendsymbol=%t
                        endsymbol=part(andexprtemp,indendsymbol($))
                        indendsymbol=indendsymbol($)
                        andexpr($)=part(andexpr($),1:indendsymbol($)-1)
                    end
                end
                for i=2:size(andexpr,"*")
                    notsymbol=strindex(stripblanks(andexpr(i)),"~")
                    if notsymbol<>[]
                        if notsymbol(1)==1 then
                            andexpr(i)="("+  stripblanks(andexpr(i)) + ")"
                        end
                    end
                end
                for kk=2:2:size(andexpr,"*")
                    andexpr=[andexpr(1:kk);"%shortcircuit";andexpr(kk+1:size(andexpr,"*"))]
                end
                tkbeg=strcat(andexpr,"&")
                if boolendsymbol then
                    tkbeg=tkbeg+endsymbol
                end
            end

            // varargout replaced by %varargout so that code can be compiled with varargout considered as a Cell
            if isempty(strindex(tkbeg,"function")) then
                tkbeg=strsubst(tkbeg,"varargout","%varargout")
            end

            txt(k)=tkbeg+com
        else // Current line has not and is not a comment line
            if first then // Function keyword not yet found
                tk=stripblanks(tk)
                if tk<>"" then // Current line is not a blank line
                    if ~(part(tk,1:9) == "function "| part(tk,1:9) == "function[") then
                        endofhelp=%t;
                        txt(k)=tk; // VC 01/04/2003
                    else
                        first_ncl=k
                        first=%f
                    end
                else
                    if ~endofhelp then helppart=[helppart;" "],end
                    txt(k)="// "
                end
            else // Current line is a line after function keyword
                endofhelp=%t
                txt(k)=tk
            end

            // Short circuiting operators
            if ~isempty(strindex(tk,"||")) then
                orexpr=tokens(tk,"|")
                indendsymbol=strindex(orexpr($),[";",","])
                boolendsymbol=%f
                if indendsymbol<>[] then
                    if stripblanks(part(orexpr($),indendsymbol($)+1:length(orexpr($))))=="" then
                        boolendsymbol=%t
                        indendsymbol=indendsymbol($)
                        endsymbol=part(orexpr($),indendsymbol($))
                        orexpr($)=part(orexpr($),1:indendsymbol($)-1)
                    end
                end
                for i=2:size(orexpr,"*")
                    notsymbol=strindex(stripblanks(orexpr(i)),"~")
                    if notsymbol<>[]
                        if notsymbol(1)==1 then
                            orexpr(i)="("+  stripblanks(orexpr(i)) + ")"
                        end
                    end
                end
                for kk=2:2:size(orexpr,"*")
                    orexpr=[orexpr(1:kk);"%shortcircuit";orexpr(kk+1:size(orexpr,"*"))]
                end
                tk=strcat(orexpr,"|")
                if boolendsymbol then
                    tk=tk+endsymbol
                end
            end
            if ~isempty(strindex(tk,"&&")) then
                andexpr=tokens(tk,"&")
                boolendsymbol=%f
                andexprtemp=andexpr($)
                indendsymbol=strindex(andexpr($),[";",","])
                if indendsymbol<>[] then
                    if stripblanks(part(andexpr($),indendsymbol($)+1:length(andexpr($))))=="" then
                        boolendsymbol=%t
                        endsymbol=part(andexprtemp,indendsymbol($))
                        indendsymbol=indendsymbol($)
                        andexpr($)=part(andexpr($),1:indendsymbol($)-1)
                    end
                end
                for i=2:size(andexpr,"*")
                    notsymbol=strindex(stripblanks(andexpr(i)),"~")
                    if notsymbol<>[]
                        if notsymbol(1)==1 then
                            andexpr(i)="("+  stripblanks(andexpr(i)) + ")"
                        end
                    end
                end
                for kk=2:2:size(andexpr,"*")
                    andexpr=[andexpr(1:kk);"%shortcircuit";andexpr(kk+1:size(andexpr,"*"))]
                end
                tk=strcat(andexpr,"&")
                if boolendsymbol then
                    tk=tk+endsymbol
                end
            end

            // varargout replaced by %varargout so that code can be compiled with varargout considered as a Cell
            if isempty(strindex(tk,"function")) then
                tk=strsubst(tk,"varargout","%varargout")
            end

            txt(k)=tk
        end
    end

    // When there is just help line in txt
    if ~endofhelp then
        txt=[]
        return
    end

    // Syntax modification

    // Complex variable
    txt=i_notation(txt)

    // Replace double quotes
    txt=strsubst(txt,dquote,dquote+dquote)

    // Replace switch by select
    txt=strsubst(txt,"switch ","select ")
    txt=strsubst(txt,"switch(","select (")

    // Replace otherwise by else
    txt=strsubst(txt,"otherwise","else")

    // Replace {..} by (..) or [..] : useful for cells translation
    txt=replace_brackets(txt)

    // Place function definition line at first line
    kc=strindex(txt(first_ncl),"function")
    if kc==[] then
        // Batch file
        txt=["function []="+fnam+"()";txt] // fnam is defined in mfile2sci()
        batch=%t
    else
        kc=kc(1)
        batch=%f
        if first_ncl<>1 then
            while strindex(txt(first_ncl($)+1),ctm)<>[] then
                first_ncl=[first_ncl,first_ncl($)+1]
            end
            txt=[txt(first_ncl);txt(1:first_ncl(1)-1);txt(first_ncl($)+1:$)]
        end
        // Beginning of BUG 2341 fix: function prototype with no comma between output parameters names
        begb=strindex(txt(1),"[");
        endb=strindex(txt(1),"]");
        if ~isempty(begb) & ~isempty(endb)
            outputparams = stripblanks(part(txt(1),(begb+1):(endb-1)))+"   ";
            k=0;
            while k<length(outputparams)
                k=k+1;
                while (and(part(outputparams,k)<>[","," "])) & (k<length(outputparams)) // skip identifier
                    k=k+1;
                end
                while (part(outputparams,k)==" ") & (k<length(outputparams)) // skip spaces before comma (or next identifier)
                    k=k+1;
                end
                if (part(outputparams,k)<>",") & (k<length(outputparams))
                    outputparams=part(outputparams,1:(k-1))+","+part(outputparams,k:length(outputparams));
                    k=k+1;
                else
                    k=k+1;
                    while (part(outputparams,k)==" ") & (k<length(outputparams)) // skip spaces after comma
                        k=k+1;
                    end
                end
            end
            txt(1)=stripblanks(part(txt(1),1:begb)+outputparams+part(txt(1),endb:length(txt(1))));
        end
        // END of BUG 2341 fix: function prototype with no comma between output parameters names
    end

endfunction