Blame src/xmlcode.l

Packit 1c1d7e
/******************************************************************************
Packit 1c1d7e
 *
Packit 1c1d7e
 * Copyright (C) 1997-2014 by Dimitri van Heesch.
Packit 1c1d7e
 *
Packit 1c1d7e
 * Permission to use, copy, modify, and distribute this software and its
Packit 1c1d7e
 * documentation under the terms of the GNU General Public License is hereby 
Packit 1c1d7e
 * granted. No representations are made about the suitability of this software 
Packit 1c1d7e
 * for any purpose. It is provided "as is" without express or implied warranty.
Packit 1c1d7e
 * See the GNU General Public License for more details.
Packit 1c1d7e
 *
Packit 1c1d7e
 * Documents produced by Doxygen are derivative works derived from the
Packit 1c1d7e
 * input used in their production; they are not affected by this license.
Packit 1c1d7e
 *
Packit 1c1d7e
 */
Packit 1c1d7e
/******************************************************************************
Packit 1c1d7e
 * Parser for syntax highlighting and references for XML
Packit 1c1d7e
 * written by Weston Thayer
Packit 1c1d7e
 ******************************************************************************/
Packit 1c1d7e
Packit 1c1d7e
%option never-interactive
Packit 1c1d7e
%option prefix="xmlcodeYY"
Packit 1c1d7e
Packit 1c1d7e
%{
Packit 1c1d7e
Packit 1c1d7e
#include <stdio.h>
Packit 1c1d7e
Packit 1c1d7e
#include "xmlcode.h"
Packit 1c1d7e
Packit 1c1d7e
#include "entry.h"
Packit 1c1d7e
#include "doxygen.h"
Packit 1c1d7e
#include "outputlist.h"
Packit 1c1d7e
#include "util.h"
Packit 1c1d7e
#include "membername.h"
Packit 1c1d7e
#include "searchindex.h"
Packit 1c1d7e
#include "config.h"
Packit 1c1d7e
#include "filedef.h"
Packit 1c1d7e
#include "tooltip.h"
Packit 1c1d7e
Packit 1c1d7e
#define YY_NEVER_INTERACTIVE 1
Packit 1c1d7e
#define YY_NO_INPUT 1
Packit 1c1d7e
#define YY_NO_UNISTD_H 1
Packit 1c1d7e
Packit 1c1d7e
static CodeOutputInterface * g_code;
Packit 1c1d7e
static QCString      g_curClassName;
Packit 1c1d7e
static QCString      g_parmType;
Packit 1c1d7e
static QCString      g_parmName;
Packit 1c1d7e
static const char *  g_inputString;     //!< the code fragment as text
Packit 1c1d7e
static int           g_inputPosition;   //!< read offset during parsing 
Packit 1c1d7e
static int           g_inputLines;      //!< number of line in the code fragment
Packit 1c1d7e
static int           g_yyLineNr;        //!< current line number
Packit 1c1d7e
static bool          g_needsTermination;
Packit 1c1d7e
static Definition   *g_searchCtx;
Packit 1c1d7e
Packit 1c1d7e
static bool          g_exampleBlock;
Packit 1c1d7e
static QCString      g_exampleName;
Packit 1c1d7e
static QCString      g_exampleFile;
Packit 1c1d7e
Packit 1c1d7e
static QCString      g_type;
Packit 1c1d7e
static QCString      g_name;
Packit 1c1d7e
static QCString      g_args;
Packit 1c1d7e
static QCString      g_classScope;
Packit 1c1d7e
   
Packit 1c1d7e
static QCString      g_CurrScope;
Packit 1c1d7e
   
Packit 1c1d7e
static FileDef *     g_sourceFileDef;
Packit 1c1d7e
static Definition *  g_currentDefinition;
Packit 1c1d7e
static MemberDef *   g_currentMemberDef;
Packit 1c1d7e
static bool          g_includeCodeFragment;
Packit 1c1d7e
static const char *  g_currentFontClass;
Packit 1c1d7e
Packit 1c1d7e
static void codify(const char* text) 
Packit 1c1d7e
{ 
Packit 1c1d7e
  g_code->codify(text);
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
static void setCurrentDoc(const QCString &anchor)
Packit 1c1d7e
{
Packit 1c1d7e
  if (Doxygen::searchIndex)
Packit 1c1d7e
  {
Packit 1c1d7e
    if (g_searchCtx)
Packit 1c1d7e
    {
Packit 1c1d7e
      Doxygen::searchIndex->setCurrentDoc(g_searchCtx,g_searchCtx->anchor(),FALSE);
Packit 1c1d7e
    }
Packit 1c1d7e
    else
Packit 1c1d7e
    {
Packit 1c1d7e
      Doxygen::searchIndex->setCurrentDoc(g_sourceFileDef,anchor,TRUE);
Packit 1c1d7e
    }
Packit 1c1d7e
  }
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
/*! start a new line of code, inserting a line number if g_sourceFileDef
Packit 1c1d7e
 * is TRUE. If a definition starts at the current line, then the line
Packit 1c1d7e
 * number is linked to the documentation of that definition.
Packit 1c1d7e
 */
Packit 1c1d7e
static void startCodeLine()
Packit 1c1d7e
{
Packit 1c1d7e
  if (g_sourceFileDef)
Packit 1c1d7e
  {   
Packit 1c1d7e
    Definition *d   = g_sourceFileDef->getSourceDefinition(g_yyLineNr);
Packit 1c1d7e
    
Packit 1c1d7e
    if (!g_includeCodeFragment && d && d->isLinkableInProject())
Packit 1c1d7e
    {
Packit 1c1d7e
      g_currentDefinition = d;
Packit 1c1d7e
      g_currentMemberDef = g_sourceFileDef->getSourceMember(g_yyLineNr);
Packit 1c1d7e
      //g_insideBody = FALSE;
Packit 1c1d7e
      g_classScope = d->name().copy();
Packit 1c1d7e
      QCString lineAnchor;
Packit 1c1d7e
      lineAnchor.sprintf("l%05d",g_yyLineNr);
Packit 1c1d7e
      if (g_currentMemberDef)
Packit 1c1d7e
      {
Packit 1c1d7e
        g_code->writeLineNumber(g_currentMemberDef->getReference(),
Packit 1c1d7e
                            g_currentMemberDef->getOutputFileBase(),
Packit 1c1d7e
                            g_currentMemberDef->anchor(),g_yyLineNr);
Packit 1c1d7e
        setCurrentDoc(lineAnchor);
Packit 1c1d7e
      }
Packit 1c1d7e
      else
Packit 1c1d7e
      {
Packit 1c1d7e
        g_code->writeLineNumber(d->getReference(),
Packit 1c1d7e
                            d->getOutputFileBase(),
Packit 1c1d7e
                            0,g_yyLineNr);
Packit 1c1d7e
        setCurrentDoc(lineAnchor);
Packit 1c1d7e
      }
Packit 1c1d7e
    }
Packit 1c1d7e
    else
Packit 1c1d7e
    {
Packit 1c1d7e
      g_code->writeLineNumber(0,0,0,g_yyLineNr);
Packit 1c1d7e
    }
Packit 1c1d7e
  }
Packit 1c1d7e
  
Packit 1c1d7e
  g_code->startCodeLine(g_sourceFileDef);
Packit 1c1d7e
  
Packit 1c1d7e
  if (g_currentFontClass)
Packit 1c1d7e
  {
Packit 1c1d7e
    g_code->startFontClass(g_currentFontClass);
Packit 1c1d7e
  }
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
static void endFontClass()
Packit 1c1d7e
{
Packit 1c1d7e
  if (g_currentFontClass)
Packit 1c1d7e
  {
Packit 1c1d7e
    g_code->endFontClass();
Packit 1c1d7e
    g_currentFontClass=0;
Packit 1c1d7e
  }
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
static void endCodeLine()
Packit 1c1d7e
{
Packit 1c1d7e
  endFontClass();
Packit 1c1d7e
  g_code->endCodeLine();
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
static void nextCodeLine()
Packit 1c1d7e
{
Packit 1c1d7e
  const char *fc = g_currentFontClass;
Packit 1c1d7e
  endCodeLine();
Packit 1c1d7e
  if (g_yyLineNr
Packit 1c1d7e
  {
Packit 1c1d7e
    g_currentFontClass = fc;
Packit 1c1d7e
    startCodeLine();
Packit 1c1d7e
  }
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
static void codifyLines(char *text)
Packit 1c1d7e
{
Packit 1c1d7e
  char *p=text,*sp=p;
Packit 1c1d7e
  char c;
Packit 1c1d7e
  bool done=FALSE;
Packit 1c1d7e
  
Packit 1c1d7e
  while (!done)
Packit 1c1d7e
  {
Packit 1c1d7e
    sp=p;
Packit 1c1d7e
    
Packit 1c1d7e
    while ((c=*p++) && c!='\n') { }
Packit 1c1d7e
    
Packit 1c1d7e
    if (c=='\n')
Packit 1c1d7e
    {
Packit 1c1d7e
      g_yyLineNr++;
Packit 1c1d7e
      *(p-1)='\0';
Packit 1c1d7e
      g_code->codify(sp);
Packit 1c1d7e
      nextCodeLine();
Packit 1c1d7e
    }
Packit 1c1d7e
    else
Packit 1c1d7e
    {
Packit 1c1d7e
      g_code->codify(sp);
Packit 1c1d7e
      done=TRUE;
Packit 1c1d7e
    }
Packit 1c1d7e
  }
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
static void startFontClass(const char *s)
Packit 1c1d7e
{
Packit 1c1d7e
  endFontClass();
Packit 1c1d7e
  g_code->startFontClass(s);
Packit 1c1d7e
  g_currentFontClass=s;
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
/*! counts the number of lines in the input */
Packit 1c1d7e
static int countLines()
Packit 1c1d7e
{
Packit 1c1d7e
  const char *p=g_inputString;
Packit 1c1d7e
  char c;
Packit 1c1d7e
  int count=1;
Packit 1c1d7e
  while ((c=*p)) 
Packit 1c1d7e
  { 
Packit 1c1d7e
    p++ ; 
Packit 1c1d7e
    if (c=='\n') count++;  
Packit 1c1d7e
  }
Packit 1c1d7e
  if (p>g_inputString && *(p-1)!='\n') 
Packit 1c1d7e
  { // last line does not end with a \n, so we add an extra
Packit 1c1d7e
    // line and explicitly terminate the line after parsing.
Packit 1c1d7e
    count++, 
Packit 1c1d7e
    g_needsTermination=TRUE; 
Packit 1c1d7e
  } 
Packit 1c1d7e
  return count;
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
#undef YY_INPUT
Packit 1c1d7e
#define YY_INPUT(buf,result,max_size) result=yyread(buf,max_size);
Packit 1c1d7e
Packit 1c1d7e
static int yyread(char *buf,int max_size)
Packit 1c1d7e
{
Packit 1c1d7e
  int c=0;
Packit 1c1d7e
  while( c < max_size && g_inputString[g_inputPosition] )
Packit 1c1d7e
  {
Packit 1c1d7e
    *buf = g_inputString[g_inputPosition++] ;
Packit 1c1d7e
    c++; buf++;
Packit 1c1d7e
  }
Packit 1c1d7e
  return c;
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
%}
Packit 1c1d7e
Packit 1c1d7e
nl          (\r\n|\r|\n)
Packit 1c1d7e
ws          [ \t]+
Packit 1c1d7e
open        "<"
Packit 1c1d7e
close       ">"
Packit 1c1d7e
namestart   [A-Za-z\200-\377_]
Packit 1c1d7e
namechar    [:A-Za-z\200-\377_0-9.-]
Packit 1c1d7e
esc         "&#"[0-9]+";"|"&#x"[0-9a-fA-F]+";"
Packit 1c1d7e
name        {namestart}{namechar}*
Packit 1c1d7e
comment     {open}"!--"([^-]|"-"[^-])*"--"{close}
Packit 1c1d7e
data        "random string"
Packit 1c1d7e
string      \"([^"&]|{esc})*\"|\'([^'&]|{esc})*\'
Packit 1c1d7e
 
Packit 1c1d7e
%option noyywrap
Packit 1c1d7e
%option nounput
Packit 1c1d7e
Packit 1c1d7e
%%
Packit 1c1d7e
Packit 1c1d7e
<INITIAL>{ws}       {
Packit 1c1d7e
                        codifyLines(yytext);
Packit 1c1d7e
                    }
Packit 1c1d7e
<INITIAL>"/"        {
Packit 1c1d7e
                        endFontClass();
Packit 1c1d7e
                        codify(yytext);
Packit 1c1d7e
                    }
Packit 1c1d7e
<INITIAL>"="        {
Packit 1c1d7e
                        endFontClass();
Packit 1c1d7e
                        codify(yytext);
Packit 1c1d7e
                    }
Packit 1c1d7e
<INITIAL>{close}    {
Packit 1c1d7e
                        endFontClass();
Packit 1c1d7e
                        codify(yytext);
Packit 1c1d7e
                    }
Packit 1c1d7e
<INITIAL>{name}     {
Packit 1c1d7e
                        startFontClass("keyword");
Packit 1c1d7e
                        codify(yytext);
Packit 1c1d7e
                        endFontClass();
Packit 1c1d7e
                    }
Packit 1c1d7e
<INITIAL>{string}   {
Packit 1c1d7e
                        startFontClass("stringliteral");
Packit 1c1d7e
                        codifyLines(yytext);
Packit 1c1d7e
                        endFontClass();
Packit 1c1d7e
                    }
Packit 1c1d7e
                    
Packit 1c1d7e
{open}{ws}?{name}   {
Packit 1c1d7e
                        // Write the < in a different color
Packit 1c1d7e
                        char openBracket[] = { yytext[0], '\0' };
Packit 1c1d7e
                        codify(openBracket);
Packit 1c1d7e
                        
Packit 1c1d7e
                        // Then write the rest
Packit 1c1d7e
                        yytext++;
Packit 1c1d7e
                        startFontClass("keywordtype");
Packit 1c1d7e
                        codify(yytext);
Packit 1c1d7e
                        endFontClass();
Packit 1c1d7e
                        
Packit 1c1d7e
                        BEGIN(INITIAL);
Packit 1c1d7e
                    }
Packit 1c1d7e
{open}{ws}?"/"{name} {
Packit 1c1d7e
                        // Write the "</" in a different color
Packit 1c1d7e
                        char closeBracket[] = { yytext[0], yytext[1], '\0' };
Packit 1c1d7e
                        endFontClass();
Packit 1c1d7e
                        codify(closeBracket);
Packit 1c1d7e
                        
Packit 1c1d7e
                        // Then write the rest
Packit 1c1d7e
                        yytext++; // skip the '<'
Packit 1c1d7e
                        yytext++; // skip the '/'
Packit 1c1d7e
                        startFontClass("keywordtype");
Packit 1c1d7e
                        codify(yytext);
Packit 1c1d7e
                        endFontClass();
Packit 1c1d7e
Packit 1c1d7e
                        BEGIN(INITIAL);
Packit 1c1d7e
                    }
Packit 1c1d7e
{comment}           {
Packit 1c1d7e
                        // Strip off the extra '!'
Packit 1c1d7e
                        // yytext++; // <
Packit 1c1d7e
                        // *yytext = '<'; // replace '!' with '<'
Packit 1c1d7e
Packit 1c1d7e
                        startFontClass("comment");
Packit 1c1d7e
                        codifyLines(yytext);
Packit 1c1d7e
                        endFontClass();
Packit 1c1d7e
                    }
Packit 1c1d7e
{nl}                {
Packit 1c1d7e
                        codifyLines(yytext);
Packit 1c1d7e
                    }
Packit 1c1d7e
Packit 1c1d7e
.                   {
Packit 1c1d7e
                        //printf("!ERROR(%c)\n", *yytext);
Packit 1c1d7e
                        codifyLines(yytext);
Packit 1c1d7e
                    }
Packit 1c1d7e
Packit 1c1d7e
%%
Packit 1c1d7e
Packit 1c1d7e
void parseXmlCode(
Packit 1c1d7e
    CodeOutputInterface &od,
Packit 1c1d7e
    const char * /*className*/,
Packit 1c1d7e
    const QCString &s,
Packit 1c1d7e
    bool exBlock,
Packit 1c1d7e
    const char *exName,
Packit 1c1d7e
    FileDef *fd,
Packit 1c1d7e
    int startLine,
Packit 1c1d7e
    int endLine,
Packit 1c1d7e
    bool inlineFragment,
Packit 1c1d7e
    MemberDef *,
Packit 1c1d7e
    bool,Definition *searchCtx,
Packit 1c1d7e
    bool /*collectXRefs*/
Packit 1c1d7e
    ) 
Packit 1c1d7e
{  
Packit 1c1d7e
  if (s.isEmpty()) return;
Packit 1c1d7e
  
Packit 1c1d7e
  TooltipManager::instance()->clearTooltips();
Packit 1c1d7e
  
Packit 1c1d7e
  g_code = &od;
Packit 1c1d7e
  g_inputString   = s;
Packit 1c1d7e
  g_inputPosition = 0;
Packit 1c1d7e
  g_currentFontClass = 0;
Packit 1c1d7e
  g_needsTermination = FALSE;
Packit 1c1d7e
  g_searchCtx=searchCtx;
Packit 1c1d7e
  
Packit 1c1d7e
  if (startLine!=-1)
Packit 1c1d7e
    g_yyLineNr    = startLine;
Packit 1c1d7e
  else
Packit 1c1d7e
    g_yyLineNr    = 1;
Packit 1c1d7e
  
Packit 1c1d7e
  if (endLine!=-1)
Packit 1c1d7e
    g_inputLines  = endLine+1;
Packit 1c1d7e
  else
Packit 1c1d7e
    g_inputLines  = g_yyLineNr + countLines() - 1;
Packit 1c1d7e
  
Packit 1c1d7e
  g_exampleBlock  = exBlock; 
Packit 1c1d7e
  g_exampleName   = exName;
Packit 1c1d7e
  g_sourceFileDef = fd;
Packit 1c1d7e
Packit 1c1d7e
  bool cleanupSourceDef = FALSE;
Packit 1c1d7e
  
Packit 1c1d7e
  if (exBlock && fd==0)
Packit 1c1d7e
  {
Packit 1c1d7e
    // create a dummy filedef for the example
Packit 1c1d7e
    g_sourceFileDef = new FileDef("",(exName?exName:"generated"));
Packit 1c1d7e
    cleanupSourceDef = TRUE;
Packit 1c1d7e
  }
Packit 1c1d7e
  
Packit 1c1d7e
  if (g_sourceFileDef) 
Packit 1c1d7e
  {
Packit 1c1d7e
    setCurrentDoc("l00001");
Packit 1c1d7e
  }
Packit 1c1d7e
Packit 1c1d7e
  g_includeCodeFragment = inlineFragment;
Packit 1c1d7e
  // Starts line 1 on the output  
Packit 1c1d7e
  startCodeLine();
Packit 1c1d7e
Packit 1c1d7e
  xmlcodeYYrestart( xmlcodeYYin );
Packit 1c1d7e
Packit 1c1d7e
  xmlcodeYYlex();
Packit 1c1d7e
Packit 1c1d7e
  if (g_needsTermination)
Packit 1c1d7e
  {
Packit 1c1d7e
    endCodeLine();
Packit 1c1d7e
  }
Packit 1c1d7e
  if (fd)
Packit 1c1d7e
  {
Packit 1c1d7e
    TooltipManager::instance()->writeTooltips(*g_code);
Packit 1c1d7e
  }
Packit 1c1d7e
  if (cleanupSourceDef)
Packit 1c1d7e
  {
Packit 1c1d7e
    // delete the temporary file definition used for this example
Packit 1c1d7e
    delete g_sourceFileDef;
Packit 1c1d7e
    g_sourceFileDef=0;
Packit 1c1d7e
  }
Packit 1c1d7e
  
Packit 1c1d7e
  return;
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
void resetXmlCodeParserState() 
Packit 1c1d7e
{
Packit 1c1d7e
  g_currentDefinition = 0;
Packit 1c1d7e
  g_currentMemberDef = 0;
Packit 1c1d7e
}
Packit 1c1d7e
Packit 1c1d7e
#if !defined(YY_FLEX_SUBMINOR_VERSION) 
Packit 1c1d7e
extern "C" { // some bogus code to keep the compiler happy
Packit 1c1d7e
  void xmlcodeYYdummy() { yy_flex_realloc(0,0); } 
Packit 1c1d7e
}
Packit 1c1d7e
#elif YY_FLEX_MAJOR_VERSION<=2 && YY_FLEX_MINOR_VERSION<=5 && YY_FLEX_SUBMINOR_VERSION<33
Packit 1c1d7e
#error "You seem to be using a version of flex newer than 2.5.4. These are currently incompatible with 2.5.4, and do NOT work with doxygen! Please use version 2.5.4 or expect things to be parsed wrongly! A bug report has been submitted (#732132)."
Packit 1c1d7e
#endif
Packit 1c1d7e