[Tex/LaTex] wrapping inline long lines and adding background color

colorhighlightingline-breakingmacrossourcecode

Objective

I'm trying to achieve the following output.

enter image description here

Here's the code I used to produce it. I had to hack it

\begin{document}
\begin{description}

\item In \texttt{./build/org.eclipse.cdt.managedbuilder.core/plugin.xml} 
\\ there is an extension  
{\btHL \texttt{org.eclipse.cdt.managedbuilder.language} } 
{ \btHL \texttt{.settings.providers.GCCBuildCommandParser}} 
corresponding to the name \texttt {GCCBuildOutputParser.name}.
This is extending at the point 
{\btHL \texttt{org.eclipse.cdt.core.LanguageSettingsProvider}}

\end{description}
\end{document}

As you can see, I had to manually insert line breaks to typeset it correctly. I'd like to have LaTeX automatically break the lines also.

The preamble that defines \btHL was taken from Highlight text in code listing while also keeping syntax highlighting

Why?

As I've shown in the example above, java classes can be really long string with no spaces. And sometimes you need to mention them inline. On top of that I think highlighting them(adding background color) will enhance the readability. As it's java code I want to typeset it in monospace. Syntax highlighting is not a high priority though.

The Challenge

So far I've looked at the following answers for wrapping text

And the following links for Highlighting and background color.

It's very tedious to try every combination of techniques from both the sets but I tried many. It seems like the hard part is that both the applications use some kind of walk through technique, the first to calculate the line break points and the second to calculate the size of the box. If it wasn't inline then setting background color wouldn't require and fancy computation and this would be doable.

Summary

So in summary, how do I achieve the same output as above without having to manually insert line breaks? I don't want to worry about typesetting while typing the reports/journal entries.

Best Answer

Two types of macros are defined. The \plaintt breaks at line endings (without any additional hyphen character added). The other one \highlighttt allows breaks only at dots, and colors the text. No break can occur in between dots.

Update: I have made the thing a bit customizable. Let me comment on the difference between the two macros: \highlighttt has the disadvantage or advantage that breaks occur only at dots. But it has the big advantage that somewhat arbitrary TeX code in-between the dots can be used. See the first paragraph in the example, where I highlighted one sub-piece in blue.

The second macro \plaintt accepts basically only letters and punctutations, but anything can be escaped from it by just putting it within braces. This is illustrated in the second paragraph.

A hook is provided so that also \plaintt can do some highlighting, character per character. See the third paragraph where only \plaintt is used, but the hook has been set to use the yellow box highlighting method.

The highlighting method for \highlighttt is specified in the command \myhighlightmethod.

Only the use of the txtt font is hardcoded in the two macros, but of course this could be changed.

\documentclass{article}
%\usepackage[T1]{fontenc}
\usepackage[textwidth=12cm]{geometry}
%\usepackage{xcolor}
\usepackage{color}


% ``private macros''
\makeatletter
\def\@highlightttpeeknext{\futurelet\@nexttoken\@highlightttaux}
\def\@highlighttt #1.{%
    \def\@highlightttaux{\ifx\@nexttoken\egroup
       \myhighlightmethod {#1}\else
       \myhighlightmethod {#1.}\linebreak[2]%
       \expandafter\@highlighttt\fi}%
    \@highlightttpeeknext}

\def\@plaintt {\futurelet\@nexttoken\@plainttaux}
\def\@plainttaux {\ifx\@nexttoken\egroup\else
                  \ifx\@nexttoken\bgroup
                  \expandafter\expandafter\expandafter\@plaintta\else
                  \expandafter\expandafter\expandafter\@plainttb\fi\fi}
\def\@plaintta #1{{#1}\@plaintt}
\def\@plainttb #1{\ifcat\@nexttoken a\penalty\hyphenpenalty \plaintthook
  #1\else \plaintthook{#1}\linebreak[2]\fi\@plaintt}



% ``commands''

\newcommand{\highlighttt}[1]{{\fontfamily{txtt}\selectfont
   \@highlighttt #1.}}

\newcommand\plaintt{\bgroup\fontfamily{txtt}\selectfont
   \afterassignment\@plaintt\let\next= }

\makeatother

% ``customization''
\newcommand{\myhighlightmethod}[1]{\fboxsep0pt\colorbox{yellow}{\strut#1}}
\newcommand{\plaintthook}{}



\begin{document}\thispagestyle{empty}

\begin{description}

\item In \plaintt{./build/org.eclipse.cdt.managedbuilder.core/plugin.xml}
  there is an extension \highlighttt{org.eclipse.cdt.{\color{blue}managedbuilder}.language.settings.providers.GCCBuildCommandParser}
  corresponding to the name \plaintt{GCCBuildOutputParser.name}. This is
  extending at the point 
  \highlighttt{org.eclipse.cdt.core.LanguageSettingsProvider}

\item In \highlighttt{./build/org.eclipse.cdt.managedbuilder.core/plugin.xml}
  there is an extension \plaintt{org.eclipse.cdt.{\color{blue}managedbuilder}.language.settings.providers.GCCBuildCommandParser}
  corresponding to the name \highlighttt{GCCBuildOutputParser.name}. This is
  extending at the point 
  \plaintt{org.eclipse.cdt.core.LanguageSettingsProvider}

\renewcommand{\plaintthook}[1]{\myhighlightmethod{#1}}

\item In \plaintt{./build/org.eclipse.cdt.managedbuilder.core/plugin.xml}
  there is an extension \plaintt{org.eclipse.cdt.{\color{blue}managedbuilder}.language.settings.providers.GCCBuildCommandParser}
  corresponding to the name \plaintt{GCCBuildOutputParser.name}. This is
  extending at the point 
  \plaintt{org.eclipse.cdt.core.LanguageSettingsProvider}

\end{description}


\end{document}

highlighting wrapped code

Known Issues:

Highlighting does not span line breaks correctly.

Code:

\documentclass{article}
\usepackage{etoolbox}
\usepackage{atbegshi,ifthen,listings,tikz}

% change this to customize the appearance of the highlight
\tikzstyle{highlighter} = [
  yellow,
  line width = \baselineskip,
]

% enable these two lines for a more human-looking highlight
%\usetikzlibrary{decorations.pathmorphing}
%\tikzstyle{highlighter} += [decorate, decoration = random steps]

% implementation of the core highlighting logic; do not change!
\newcounter{highlight}[page]
\newcommand{\tikzhighlightanchor}[1]{\ensuremath{\vcenter{\hbox{\tikz[remember picture, overlay]{\coordinate (#1 highlight \arabic{highlight});}}}}}
\newcommand{\bh}[0]{\stepcounter{highlight}\tikzhighlightanchor{begin}}
\newcommand{\eh}[0]{\tikzhighlightanchor{end}}
\AtBeginShipout{\AtBeginShipoutUpperLeft{\ifthenelse{\value{highlight} > 0}{\tikz[remember picture, overlay]{\foreach \stroke in {1,...,\arabic{highlight}} \draw[highlighter] (begin highlight \stroke) -- (end highlight \stroke);}}{}}}
%--------------------------


\makeatletter %   Redefine macros from listings package:
\newtoggle{@InInlineListing}%
\togglefalse{@InInlineListing}%

\renewcommand\lstinline[1][]{%
    \leavevmode\bgroup\toggletrue{@InInlineListing}\bh % \hbox\bgroup --> \bgroup
      \def\lst@boxpos{b}%
      \lsthk@PreSet\lstset{flexiblecolumns,#1}%
      \lsthk@TextStyle
      \@ifnextchar\bgroup{\afterassignment\lst@InlineG \let\@let@token}%
                         \lstinline@}%

\def\lst@LeaveAllModes{%
    \ifnum\lst@mode=\lst@nomode
        \expandafter\lsthk@EndGroup\iftoggle{@InInlineListing}{\eh{}}{}%
    \else
        \expandafter\egroup\expandafter\lst@LeaveAllModes
    \fi%
    }
\makeatother


\lstset{backgroundcolor=\color{green!10}}%

\begin{document}
The following \emph{inline} code snippet should appear
in a frame (or highlighted) if lstinline command is properly redefined above:
\lstinline´chainl1(term, "+" ^^^ Add | "-" ^^^ Sub)´Now back to regular text

\bigskip
The lstlisting environment is not affected:
\begin{lstlisting}
    chainl1(term, "+" ^^^ Add | "-" ^^^ Sub)
\end{lstlisting}
\end{document}

[Tex/LaTex] How to mark whole line or part of line with background color in a listing (listings package)

Listings allow escaping to TeX, so you can put a box in the background:

\documentclass{standalone}
\usepackage{listings,xcolor}
\lstset{language=c,escapechar=|}
\begin{document}
\begin{lstlisting}
int main (int argc, char ** argv)
{
  |\makebox[0pt]{\color{yellow}\rule[-0.1ex]{30em}{2ex}}|printf("Hello, world\n");
  exit(0);
}
\end{lstlisting}
\end{document}