void CmdLabel(int code)
/******************************************************************************
purpose: handles \label \ref \pageref \cite
******************************************************************************/
{
char *text, *signet, *s;
char *option = NULL;
int mode=GetTexMode();
option = getBracketParam();
text = getBraceParam();
if (strlen(text)==0) {
free(text);
return;
}
switch (code) {
case LABEL_LABEL:
if (g_processing_figure || g_processing_table) break;
if (mode == MODE_DISPLAYMATH) {
g_equation_label = strdup_nobadchars(text);
diagnostics(3,"equation label is <%s>",text);
} else
InsertBookmark(text,"");
break;
case LABEL_HYPERREF:
case LABEL_REF:
signet = strdup_nobadchars(text);
s = ScanAux("newlabel", text, 1);
if (g_fields_use_REF) {
fprintRTF("{\\field{\\*\\fldinst{\\lang1024 REF BM%s \\\\* MERGEFORMAT }}",signet);
fprintRTF("{\\fldrslt{");
}
if (s)
ConvertString(s);
else
fprintRTF("?");
if (g_fields_use_REF) fprintRTF("}}}");
free(signet);
if (s) free(s);
break;
case LABEL_HYPERPAGEREF:
case LABEL_PAGEREF:
signet = strdup_nobadchars(text);
if (g_fields_use_REF) {
fprintRTF("{\\field{\\*\\fldinst{\\lang1024 PAGEREF BM%s \\\\* MERGEFORMAT }}",signet);
fprintRTF("{\\fldrslt{");
}
fprintRTF("%s",signet);
if (g_fields_use_REF) fprintRTF("}}}");
free(signet);
break;
}
free(text);
if (option) free(option);
}
void
InsertBookmark(char *name, char *text)
{
char *signet;
if (!name) {
fprintRTF("%s",text);
return;
}
signet = strdup_nobadchars(name);
if (ExistsBookmark(signet)) {
diagnostics(3,"bookmark %s already exists",signet);
} else {
diagnostics(3,"bookmark %s being inserted around <%s>",signet,text);
RecordBookmark(signet);
if (g_fields_use_REF)
fprintRTF("{\\*\\bkmkstart BM%s}",signet);
fprintRTF("%s",text);
if (g_fields_use_REF)
fprintRTF("{\\*\\bkmkend BM%s}",signet);
}
free(signet);
}
/******************************************************************************
purpose: return a copy of tag from \label{tag} in the string text
******************************************************************************/
char *ExtractLabelTag(const char *text)
{
char *s, *label_with_spaces, *label;
s = strstr(text, "\\label{");
if (!s)
s = strstr(text, "\\label ");
if (!s)
return NULL;
s += strlen("\\label");
PushSource(NULL, s);
label_with_spaces = getBraceParam();
PopSource();
label = strdup_nobadchars(label_with_spaces);
free(label_with_spaces);
diagnostics(4, "LabelTag = <%s>", (label) ? label : "missing");
return label;
}
void
CmdBibitem(int code)
{
char *label, *key, *signet, *s, c;
g_processing_list_environment=TRUE;
CmdEndParagraph(0);
CmdStartParagraph(FIRST_PAR);
label = getBracketParam();
key = getBraceParam();
signet = strdup_nobadchars(key);
s=ScanAux("bibcite", key, 0);
if (label && !s) { /* happens when file needs to be latex'ed again */
diagnostics(WARNING,"file needs to be latexed again for references");
fprintRTF("[");
ConvertString(label);
fprintRTF("]");
} else {
diagnostics(4,"CmdBibitem <%s>",s);
if (g_document_bibstyle == BIBSTYLE_STANDARD) {
// fprintRTF("[");
fprintRTF("{\\v\\*\\bkmkstart BIB_%s}",signet);
ConvertString(s);
fprintRTF("{\\*\\bkmkend BIB_%s}",signet);
// fprintRTF("]");
fprintRTF(".");
fprintRTF("\\tab ");
}
/* else emit nothing for APALIKE */
}
if (s) free(s);
if (label) free(label);
free(signet);
free(key);
c=getNonBlank();
ungetTexChar(c);
}
char *
ExtractLabelTag(char *text)
/******************************************************************************
purpose: return a copy of tag from \label{tag} in the string text
******************************************************************************/
{
char *s, *label_with_spaces, *label;
s = strstr(text,"\\label{");
if (!s) s = strstr(text,"\\label ");
if (!s) return NULL;
s += strlen("\\label");
PushSource(NULL,s);
label_with_spaces = getBraceParam();
PopSource();
label = strdup_nobadchars(label_with_spaces);
free(label_with_spaces);
diagnostics(4, "LabelTag = <%s>", (label) ? label : "missing");
return label;
}
void preParse(char **body, char **header, char **label)
/**************************************************************************
purpose: obtain the next section of the latex file
This is now a preparsing routine that breaks a file up into sections.
Macro expansion happens here as well. \input and \include are also
handled here. The reason for this routine is allow \labels to refer
to sections.
This routine reads text until a new section heading is found. The text
is returned in body and the *next* header is returned in header. If
no header follows then NULL is returned.
**************************************************************************/
{
int any_possible_match, found;
char cNext, cThis, *s, *text, *next_header, *str, *p;
int i;
int possible_match[43];
char *command[43] = { "", /* 0 entry is for user definitions */
"", /* 1 entry is for user environments */
"\\begin{verbatim}",
"\\begin{figure}", "\\begin{figure*}",
"\\begin{equation}", "\\begin{equation*}",
"\\begin{eqnarray}", "\\begin{eqnarray*}",
"\\begin{table}", "\\begin{table*}",
"\\begin{description}", "\\begin{comment}",
"\\end{verbatim}",
"\\end{figure}", "\\end{figure*}",
"\\end{equation}", "\\end{equation*}",
"\\end{eqnarray}", "\\end{eqnarray*}",
"\\end{table}", "\\end{table*}",
"\\end{description}", "\\end{comment}",
"\\part", "\\chapter", "\\section", "\\subsection", "\\subsubsection",
"\\section*", "\\subsection*", "\\subsubsection*",
"\\label", "\\input", "\\include", "\\verb", "\\url", "\\nolinkurl",
"\\newcommand", "\\def", "\\renewcommand", "\\endinput", "\\end{document}",
};
int ncommands = 43;
const int b_verbatim_item = 2;
const int b_figure_item = 3;
const int b_figure_item2 = 4;
const int b_equation_item = 5;
const int b_equation_item2 = 6;
const int b_eqnarray_item = 7;
const int b_eqnarray_item2 = 8;
const int b_table_item = 9;
const int b_table_item2 = 10;
const int b_description_item = 11;
const int b_comment_item = 12;
const int e_verbatim_item = 13;
const int e_figure_item = 14;
const int e_figure_item2 = 15;
const int e_equation_item = 16;
const int e_equation_item2 = 17;
const int e_eqnarray_item = 18;
const int e_eqnarray_item2 = 19;
const int e_table_item = 20;
const int e_table_item2 = 21;
const int e_description_item = 22;
const int e_comment_item = 23;
const int label_item = 32;
const int input_item = 33;
const int include_item = 34;
const int verb_item = 35;
const int url_item = 36;
const int nolinkurl_item = 37;
const int new_item = 38;
const int def_item = 39;
const int renew_item = 40;
const int endinput_item = 41;
const int e_document_item = 42;
int bs_count = 0; /* number of backslashes encountered in a row */
size_t cmd_pos = 0; /* position of start of command relative to end of buffer */
int label_depth = 0;
int i_match = 0;
text = NULL;
next_header = NULL; /* typically becomes \subsection{Cows eat grass} */
*body = NULL;
*header = NULL;
*label = NULL;
PushTrackLineNumber(FALSE);
reset_buffer();
while (1) {
cThis = getRawTexChar();
while (cThis == '\0' && getParserDepth() > 0) {
PopSource();
diagnostics(4,"parser depth is now %d", getParserDepth());
cThis = getRawTexChar();
}
if (cThis == '\0')
diagnostics(6, "[%ld] xchar=000 '\\0' (backslash count=%d)", section_buffer_end, bs_count);
else if (cThis == '\n')
diagnostics(6, "[%ld] xchar=012 '\\n' (backslash count=%d)", section_buffer_end, bs_count);
else
diagnostics(6, "[%ld] xchar=%03d '%c' (backslash count=%d)", section_buffer_end, (int) cThis, cThis, bs_count);
cThis = skipBOM(cThis);
add_chr_to_buffer(cThis);
if (cThis == '\0') break;
if (cThis == '%' && even(bs_count)) {
int n = 1; /* remove initial % */
do {
cNext = getRawTexChar();
add_chr_to_buffer(cNext);
n++;
} while (cNext != '\n' && cNext != '\0');
move_end_of_buffer(-n);
if (0) show_buffer("percent");
continue;
}
/* cmd_pos > 0 means that we have encountered a '\' and some
fraction of a command, e.g., '\sec', therefore the first
time that a backslash is found then cmd_pos becomes 1, */
if (cThis == '\\') {
bs_count++;
if (odd(bs_count)) { /* avoid "\\section" and "\\\\section" */
for (i = 0; i < ncommands; i++)
possible_match[i] = TRUE;
cmd_pos = 1;
continue;
}
} else
bs_count = 0;
if (cmd_pos == 0) continue;
/* replace "\ " and "\\n" with a space */
if (cmd_pos == 1 && (cThis == '\n' || cThis == ' ') ) {
move_end_of_buffer(-1);
add_chr_to_buffer(' ');
cmd_pos = 0;
continue;
}
/* at this point we are have encountered a command and may have to do something.
if it is a user definition, then the user definition is expanded here
if it is a user environment, then expansion also happens here
it it is something else then we may or may not have to mess with it. */
/* hack to convert '\begin {' --> '\begin{' */
if (cThis==' ' && (matches_buffer_tail("\\begin") || matches_buffer_tail("\\end")) ) {
diagnostics(5, "matched '\\begin ' or '\\end '");
do {cThis = getRawTexChar();} while (cThis == ' ');
}
/* hack to convert '\begin{ ' --> '\begin{' */
if (cThis==' ' && (matches_buffer_tail("\\begin{") || matches_buffer_tail("\\end{")) ) {
diagnostics(5, "matched '\\begin{ ' or '\\end{ '");
do {cThis = getRawTexChar();} while (cThis == ' ');
}
any_possible_match = FALSE;
found = FALSE;
/* is is possibly a user defined command? */
if (possible_match[0]) {
possible_match[0] = maybeDefinition(section_buffer + section_buffer_end - cmd_pos + 1, cmd_pos - 1);
if (possible_match[0]) { /* test to make sure \userdef is complete */
any_possible_match = TRUE;
cNext = getRawTexChar(); /* wrong when cNext == '%' */
ungetTexChar(cNext);
if (!isalpha((int) cNext)) { /* is macro name complete? */
*(section_buffer + section_buffer_end + 1) = '\0';
i = existsDefinition(section_buffer + section_buffer_end - cmd_pos + 1);
if (i > -1) {
diagnostics(4, "matched <%s> ", section_buffer + section_buffer_end - cmd_pos);
if (cNext == ' ') {
cNext = getNonSpace();
ungetTexChar(cNext);
}
move_end_of_buffer(-cmd_pos-1); /* remove \userdef */
str = expandDefinition(i);
PushSource(NULL, str);
free(str);
cmd_pos = 0;
bs_count = 0;
continue;
}
}
}
}
/* is it a user defined environment? */
if (possible_match[1]) {
char *pp = section_buffer + section_buffer_end - cmd_pos;
possible_match[1] = maybeEnvironment(pp, cmd_pos);
if (possible_match[1] == TRUE) {
any_possible_match = TRUE;
cNext = getRawTexChar(); /* wrong when cNext == '%' */
/* \begin{name} or \end{name} will end with '}' */
if (cNext == '}') {
char *ss = NULL;
*(pp + cmd_pos + 1) = '\0';
if (*(pp + 1) == 'e') {
i = existsEnvironment(pp + strlen("\\end{"));
ss = expandEnvironment(i, CMD_END);
} else {
i = existsEnvironment(pp + strlen("\\begin{"));
ss = expandEnvironment(i, CMD_BEGIN);
}
if (ss) { /* found */
diagnostics(5, "matched <%s}>", pp);
diagnostics(5, "expanded to <%s>", ss);
PushSource(NULL, ss);
move_end_of_buffer(-cmd_pos-1); /* remove \begin{userenvironment} */
free(ss);
cmd_pos = 0;
continue;
}
}
ungetTexChar(cNext); /* put the character back */
}
}
/* is it one of the commands listed above? */
for (i = 2; i < ncommands; i++) {
if (possible_match[i]) {
if (cThis == command[i][cmd_pos])
any_possible_match = TRUE;
else
possible_match[i] = FALSE;
diagnostics(6,"cmd_pos = %d, char = %c, possible match %s, size=%d, possible=%d", \
cmd_pos,cThis,command[i],strlen(command[i]),possible_match[i]);
}
}
i_match = -1;
for (i = 2; i < ncommands; i++) { /* discover any exact matches */
if (possible_match[i]) {
diagnostics(6, "testing for <%s>", command[i]);
/* right length? */
if (cmd_pos+1 == strlen(command[i])) {
if (i<=e_comment_item || i==e_comment_item) {
/* these entries are complete matches */
found = TRUE;
} else {
/* these entries we need to be a bit more careful and check next character */
cNext = getRawTexChar();
ungetTexChar(cNext);
/* this test for the end of commands may still need tweaking */
if (!isalpha(cNext) && cNext != '*') {
found = TRUE;
}
}
}
}
if (found == TRUE) {
diagnostics(6,"preparse matched '%s'",command[i]);
i_match = i;
break;
}
}
if (any_possible_match)
cmd_pos++;
else
cmd_pos = 0; /* no possible matches, reset and wait for next '\\' */
if (!found)
continue;
if (i_match == endinput_item) {
diagnostics(6, "\\endinput");
move_end_of_buffer(-9); /* remove \endinput */
PopSource();
cmd_pos = 0; /* keep looking */
continue;
}
/* \end{document} reached! Stop processing */
if (i_match == e_document_item) {
diagnostics(6, "\\end{document}");
move_end_of_buffer(-strlen(command[e_document_item]));
add_chr_to_buffer('\0');
safe_free(*header);
*header = strdup(command[e_document_item]);
p = section_buffer;
while (*p==' ' || *p == '\n') p++;
*body = strdup(p);
PopTrackLineNumber();
diagnostics(6, "body = %s", section_buffer);
diagnostics(6, "next header = '%s'", command[e_document_item]);
return;
}
if (i_match == verb_item) { /* slurp \verb#text# */
char cc;
cNext = getRawTexChar();
add_chr_to_buffer(cNext);
diagnostics(6, "verb char = %c", cNext);
do {
cc = getRawTexChar();
add_chr_to_buffer(cc);
} while (cc != cNext && cc != '\0');
cmd_pos = 0; /* reset the command position */
continue;
}
/* cannot ignore this because it may contain unescaped '%' */
if (i_match == url_item || i_match == nolinkurl_item) {
char cc;
do {
cc = getRawTexChar();
add_chr_to_buffer(cc);
} while (cc != '\0' && cc != '}');
cmd_pos = 0; /* reset the command position */
continue;
}
if (i_match == include_item) {
CmdInclude(0);
move_end_of_buffer(-strlen(command[i]));
cmd_pos = 0; /* reset the command position */
continue;
}
if (i_match == input_item) {
CmdInclude(1);
move_end_of_buffer(-strlen(command[i]));
cmd_pos = 0; /* reset the command position */
continue;
}
if (i_match == label_item) {
char *tag;
tag = getBraceParam();
/* append \label{tag} to the buffer */
add_chr_to_buffer('{');
add_str_to_buffer(tag);
add_chr_to_buffer('}');
if (!(*label) && strlen(tag) && label_depth == 0)
*label = strdup_nobadchars(tag);
free(tag);
cmd_pos = 0; /* keep looking */
continue;
}
/* process any new definitions */
if (i_match == def_item || i_match == new_item || i_match == renew_item) {
cNext = getRawTexChar(); /* wrong when cNext == '%' */
ungetTexChar(cNext);
if (isalpha((int) cNext)) /* is macro name complete? */
continue;
move_end_of_buffer(-strlen(command[i])); /* do not include in buffer */
if (i_match == def_item)
CmdNewDef(DEF_DEF);
else if (i_match == new_item)
CmdNewDef(DEF_NEW);
else
CmdNewDef(DEF_RENEW);
cmd_pos = 0; /* keep looking */
continue;
}
if (i_match == b_figure_item || i_match == b_figure_item2 ||
i_match == b_equation_item || i_match == b_equation_item2 ||
i_match == b_eqnarray_item || i_match == b_eqnarray_item2 ||
i_match == b_table_item || i_match == b_table_item2 ||
i_match == b_description_item) {
label_depth++; /* labels now will not be the section label */
cmd_pos = 0;
continue;
}
if (i_match == e_figure_item || i_match == e_figure_item2 ||
i_match == e_equation_item || i_match == e_equation_item2 ||
i_match == e_eqnarray_item || i_match == e_eqnarray_item2 ||
i_match == e_table_item || i_match == e_table_item2 ||
i_match == e_description_item) {
label_depth--; /* labels may now be the section label */
cmd_pos = 0;
continue;
}
if (i_match == b_verbatim_item) { /* slurp environment ... toxic contents! */
s = getTexUntil(command[e_verbatim_item], TRUE);
add_str_to_buffer(s);
free(s);
add_str_to_buffer(command[e_verbatim_item]);
diagnostics(4,"matched \\end{verbatim}");
cmd_pos = 0; /* keep looking */
continue;
}
if (i_match == b_comment_item) { /* slurp environment ... toxic contents! */
s = getTexUntil(command[e_comment_item], TRUE);
add_str_to_buffer(s);
free(s);
add_str_to_buffer(command[e_comment_item]);
cmd_pos = 0; /* keep looking */
continue;
}
diagnostics(4, "possible end of section");
diagnostics(4, "label_depth = %d", label_depth);
if (label_depth > 0) /* still in a \begin{xxx} environment? */
continue;
/* actually found command to end the section */
diagnostics(4, "preParse() found command to end section");
s = getBraceParam();
next_header = strdup_together4(command[i], "{", s, "}");
free(s);
move_end_of_buffer(-strlen(command[i]));
add_chr_to_buffer('\0');
break;
}
/*eliminate white space at beginning of buffer */
p = section_buffer;
while (*p==' ' || *p == '\n') p++;
*body = strdup(p);
safe_free(*header);
*header = next_header;
PopTrackLineNumber();
}
void CmdCite(int code)
/******************************************************************************
purpose: handles \cite
******************************************************************************/
{
char punct[4]="[],";
char *text, *str1;
char *keys, *key, *next_keys;
char *option = NULL;
char *pretext = NULL;
/* Setup punctuation and read options before citation */
g_current_cite_paren=TRUE;
*g_last_author_cited='\0';
if (g_document_bibstyle == BIBSTYLE_STANDARD){
option = getBracketParam();
}
if (g_document_bibstyle == BIBSTYLE_APALIKE){
strcpy(punct,"();");
option = getBracketParam();
}
if (g_document_bibstyle == BIBSTYLE_AUTHORDATE){
strcpy(punct,"();");
option = getBracketParam();
}
if (g_document_bibstyle == BIBSTYLE_NATBIB){
pretext = getBracketParam();
option = getBracketParam();
strcpy(punct,"();");
if (code!=CITE_P && code!=CITE_P_STAR &&
code!=CITE_ALP && code!=CITE_ALP_STAR && code!=CITE_YEAR_P)
g_current_cite_paren=FALSE;
}
if (g_document_bibstyle == BIBSTYLE_APACITE){
pretext = getAngleParam();
option = getBracketParam();
strcpy(punct,"();");
if (code!=CITE_CITE && code!=CITE_FULL && code!=CITE_SHORT && code!=CITE_YEAR)
g_current_cite_paren=FALSE;
g_current_cite_type=code;
}
text = getBraceParam();
str1 = strdup_nocomments(text);
free(text);
text=str1;
if (strlen(text)==0) {
free(text);
if (pretext) free(pretext);
if (option) free(option);
return;
}
/* output text before citation */
if (g_current_cite_paren)
fprintRTF("\n%c", punct[0]);
if (pretext && g_document_bibstyle == BIBSTYLE_APACITE ) {
ConvertString(pretext);
fprintRTF(" ");
}
/* now start processing keys */
keys = strdup_noblanks(text);
free(text);
key = keys;
next_keys = popCommaName(key);
g_current_cite_item=0;
while (key) {
char *s, *t;
g_current_cite_item++;
s = ScanAux("bibcite", key, 0); /* look up bibliographic reference */
if (g_document_bibstyle == BIBSTYLE_APALIKE) { /* can't use Word refs for APALIKE or APACITE*/
t = s ? s : key;
ConvertString(t);
}
if (g_document_bibstyle == BIBSTYLE_AUTHORDATE) {
t = s ? s : key;
if (code==CITE_SHORT)
g_suppress_name=TRUE;
ConvertString(t);
if (code==CITE_SHORT)
g_suppress_name=FALSE;
}
if (g_document_bibstyle == BIBSTYLE_APACITE) { /* */
t = s ? s : key;
g_current_cite_seen=citation_used(key);
ConvertString(t);
}
if (g_document_bibstyle == BIBSTYLE_NATBIB) {
diagnostics(2,"natbib key=[%s] <%s>",key, s);
if (s) {
g_current_cite_seen=citation_used(key);
ConvertNatbib(s,code,pretext,option);
} else
ConvertString(key);
}
if (g_document_bibstyle == BIBSTYLE_STANDARD) { /* */
char *signet = strdup_nobadchars(key);
t = s ? s : signet; /* if .aux is missing or incomplete use original citation */
if (g_fields_use_REF) {
fprintRTF("{\\field{\\*\\fldinst{\\lang1024 REF BIB_%s \\\\* MERGEFORMAT }}",signet);
fprintRTF("{\\fldrslt{");
}
ConvertString(t);
if (g_fields_use_REF) fprintRTF("}}}");
if (signet) free(signet);
}
if (next_keys) fprintRTF("%c ",punct[2]); /* punctuation between citations */
key=next_keys;
next_keys=popCommaName(key); /* key modified to be a single key */
if (s) free(s);
}
/* final text after citation */
if (option && (g_document_bibstyle == BIBSTYLE_APACITE || g_document_bibstyle == BIBSTYLE_AUTHORDATE)) {
fprintRTF(", ");
ConvertString(option);
}
if (g_current_cite_paren) fprintRTF("\n%c", punct[1]);
if (keys) free(keys);
if (option) free(option);
if (pretext) free(pretext);
}