colorize-latex-errors.sed

#(##defaults(color_error="<E>", color_reset="<R>")##)

# Remove lonely ) - they are meaningful in some sense, but we don't parse the
# log file hierarchically, so they're just a problem. They always appear by
# themselves, and they always make a sensible place to break a paragraph.
s/^)$//

#(##include("paragraphs.sed")##)

# File not found errors (e.g., for class and package files) require two more
# paragraphs to process properly And they don't start with a line number - that
# comes later by the "Emergency stop" output.
/^! LaTeX Error: File /{
  # Get rid of newlines, since splits on the first paragraph happen in
  # interesting places.
  s/\n//g
  b needtwomore
}

# With -file-line-error specified in latex options, we get things like
# ./blah.tex:2: LaTeX Error
# (among other things).  We find all lines that look like they might contain a
# filename and line number and add an easy-to-find prefix to them.  That way we
# can easily find most errors, stuff that isn't called out here explicitly.
s/^[^[:cntrl:]:]*:[[:digit:]]\{1,\}:/!!! &/
# Note that we preserve all of the stuff before the !!! because it might
# contain useful errors that we have to find below.  Of particular interest is
# the File `something.cls' not found case.
# Note that any time we need to negate \n, we use [^[:cntrl:]] instead, since
# [^\n] doesn't work in POSIX sed.
s/^\(.*\n\)\([^[:cntrl:]:]*:[[:digit:]]\{1,\}: .*\)/\1!!! \2/

# Graphics files that go missing need only two paragraphs, and the
# filename:line: is at the beginning of the error message.
/^!!! .*[[:space:][:cntrl:]]LaTeX[[:space:][:cntrl:]]Error:[[:space:][:cntrl:]]*File /{
  # Get rid of newlines first, since latex error output is split on column
  # boundaries regardless of context.
  s/\n//g
  b needonemore
}

# Parse things that look like this (triple paragraphs)
# ! LaTeX Error: File `missing.cls' not found.
#
# Type X to quit or <RETURN> to proceed,
# or enter new name. (Default extension: cls)
#
# Enter file name:
# ./test-missing-cls.tex:2: Emergency stop.
# <read *>
#
# l.2 ^^M
#
# *** (cannot \read from terminal in nonstop modes)
/^::0::! LaTeX Error: File .*/{
  # Request another paragraph if we run into the weird case where an error line
  # is split just before its newline.
  /\n\n$/{
    s/^::0:://
    b needonemore
  }
  # Remove paragraph prefix
  s/^::0::! //
  s/^\(.*not found.\).*Enter file name:.*\n\(.*[[:digit:]]\{1,\}\): Emergency stop.*/\2: \1/
  b error
}

# Parse regular old file missing errors (not the special kind like classes and
# packages, but more mundane ones like missing graphics).
/^::0::!!! .*LaTeX Error: File .*/{
  # Request another paragraph if we run into the weird case where an error line
  # is split just before its newline.
  /\n\n$/{
    s/^::0:://
    b needonemore
  }
  # Remove the paragraph prefix
  s/::0::!!! //
  # Deal with missing eps files specially (they are usually included graphics,
  # and are caught by the graphics inclusion logic anyway).  Note that we don't
  # do the same for pdflatex-included graphics, since those are always included
  # as stems, and the extension is dynamically determined.  This only shows up
  # in .eps inclusion using plain latex.
  /File .*\.e\{0,1\}ps' not found/b skip
  # Handle file missing errors where we are looking for a particular extension
  /could not locate.*any of these extensions:/{
    # We don't do anything with these - they are missing graphics.
    b skip
    # NOTE: this is here just in case we need it later.  In general, we don't
    # treat missing graphics as an error because they end up as dependencies,
    # which causes other errors in other ways.  If we colorize this, it ends up
    # as a fatal error to be missing a graphic.  We'd rather see it just add the
    # dependency and move on.
    #s/\(not found\.\).*extensions:.\([^[:cntrl:]]*\).*/\1  Extensions tried: \2/
    #s/,/, /g
    #b error
  }
  # Handle everything else
  s/\(not found\.\).*/\1/
  # Add the !!! prefix back, to allow highlighting to occur.
  s/^/!!! /
  b error
}

# This one is simple: find a single line that says we're missing
# begin{document} and colorize it.  Because this commonly happens when trying
# to build an include file (e.g., when typing "make" without a target in a
# directory that has a bunch of .tex files that are included in another), we
# handle it specially here.
/^\(.* LaTeX Error: Missing .begin.document.\.\).*/{
  s//\1 --- Are you trying to build an include file?/
  b error
}

# Runaway arguments are formatted a bit differently. They have have the /^! /
# stuff on a later line, in the first paragraph. So we just handle them
# specially here.
/^Runaway argument?/{
  s/I'll try to recover.*//
  b error
}

# We deal with this one specially because it tends to be buried at the end of
# long paragraphs of other stuff, so it requires interesting processing.
# With the addition of the handy error prefix, though, we just need to delete
# the stuff before it and make the rest pretty.
# E.g., we want to parse this:
# LaTeX Font Info:    Checking defaults for OML/cmm/m/it on input line 5.
# LaTeX Font Info:    ... okay on input line 5.
# LaTeX Font Info:    Checking defaults for T1/cmr/m/n on input line 5.
# LaTeX Font Info:    ... okay on input line 5.
# LaTeX Font Info:    Checking defaults for OT1/cmr/m/n on input line 5.
# LaTeX Font Info:    ... okay on input line 5.
# LaTeX Font Info:    Checking defaults for OMS/cmsy/m/n on input line 5.
# LaTeX Font Info:    ... okay on input line 5.
# LaTeX Font Info:    Checking defaults for OMX/cmex/m/n on input line 5.
# LaTeX Font Info:    ... okay on input line 5.
# LaTeX Font Info:    Checking defaults for U/cmr/m/n on input line 5.
# LaTeX Font Info:    ... okay on input line 5.
# ./test.tex:6: Undefined control sequence.
# l.6 \halp
#
# The control sequence at the end of the top line
# of your error message was never \def'ed. If you have
# misspelled it (e.g., `\hobx'), type `I' and the correct
# spelling (e.g., `I\hbox'). Otherwise just continue,
# and I'll forget about whatever was undefined.
/.*\(!!! .*Undefined control sequence\)[^[:cntrl:]]*\(.*\)/{
  s//\1: \2/
  s/\nl\.[[:digit:]][^[:cntrl:]]*\(\\[^\\[:cntrl:]]*\).*/\1/
  b error
}

# Handle some fatal error cases
/^\(!pdfTeX error:.*\)s*/{
  b error
}

# Finally, we handle anything that looks remotely like an error that we
# haven't already caught.
/.*\(!!! .*\)/{
  s//\1/
  s/[[:cntrl:]]//
  s/[[:cntrl:]]$//
  /Cannot determine size of graphic .*(no BoundingBox)/b skip
  b error
}

# Anything not dealt with above gets dumped into the trash.
:skip
d

# If we have an error (starts with !!! and we get this far), then strip the
# prefix, colorize, and output.
:error
s/^!\(!! \)\{0,1\}\(.*\)/(##color_error##)\2(##color_reset##)/
p
d