exporting inline source code with listings broken by color commands

exporting inline source code with listings broken by color commands

[Tyler Smith]

When exporting an org file to pdf via latex, and using the listings
package to markup source code, my inline code is not processed properly.

To reproduce:
 
    emacs -Q -l minimal.el

where minimal.el contains the following:

;;; Minimal setup to load latest 'org-mode'

;; activate debugging
(setq debug-on-error t
      debug-on-signal nil
      debug-on-quit nil)
     
;; add latest org-mode to load path
(add-to-list 'load-path (expand-file-name
"/home/tws/.emacs.d/elpa/org-plus-contrib-20170606"))

(setq org-latex-listings t
      org-latex-listings-options
      '(("backgroundcolor" "\\color[gray]{0.95}")
       ("keywordstyle" "\\color{blue}")
       ("commentstyle" "\\color{BrickRed}")
       ("stringstyle" "\\color{Red}")
       ("keepspaces" "true")
       ("deletekeywords" "{ps,scan}"))
      org-latex-packages-alist
      '(("usenames,dvipsnames" "color" nil)
	("" "listings" nil)))

(org-babel-do-load-languages
 'org-babel-load-languages
 '((emacs-lisp . t)
   (R . t)
   (shell . t)))


Then open tmp.org, which contains the following:

# -*- org-export-babel-evaluate: nil -*-
#+PROPERTY: header-args:sh :session *bp*

* Init
  Set working directory, set path to taxonomy tree and database.
  
  #+BEGIN_SRC sh :results silent 
    cd /home/tws/research
    
    ## do other shell stuff here

  #+END_SRC

  #+BEGIN_SRC R :session tmp
    1 + 1                           
  #+END_SRC

  #+RESULTS:
  : 2

  Inline code: src_R{1 + 1} {{{results(=2=)}}}


Export to pdf via C-c C-e l o

What I expect to happen is that the last line is rendered as "Inline
code: 2". What I see instead is: 

Inline code:
0.95,keywordstyle=,commentstyle=,stringstyle=,keepspaces=true,deletekeywords=ps,sc
+1 2

I think this may be due to the latex listings package being able to
accommodate color macros in code blocks (\lstlisting), but in inline
code (\lstinline). I can eliminate the problem by removing the color
commands. However, it would be better to provide an option to pass
separate arguments to lstlisting and lstinline, so that we can still use
colors where they are supported.

Additional details below.

Best,

Tyler


Emacs  : GNU Emacs 26.0.50 (build 2, x86_64-pc-linux-gnu, GTK+ Version
3.22.11)
 of 2017-06-18
Package: Org mode version 9.0.8 (9.0.8-elpaplus @
/home/tws/.emacs.d/elpa/org-plus-contrib-20170606/)

current state:
==============
(setq
 org-src-mode-hook '(org-src-babel-configure-edit-buffer
		     org-src-mode-configure-edit-buffer)
 org-after-todo-state-change-hook '(org-clock-out-if-current)
 org-latex-listings t
 org-metadown-hook '(org-babel-pop-to-session-maybe)
 org-clock-out-hook '(org-clock-remove-empty-clock-drawer)
 org-html-format-inlinetask-function
 'org-html-format-inlinetask-default-function
 org-odt-format-headline-function
 'org-odt-format-headline-default-function
 org-ascii-format-inlinetask-function
 'org-ascii-format-inlinetask-default
 org-mode-hook '(#[0 "\300\301\302\303\304$\207"
		   [add-hook change-major-mode-hook
		    org-show-block-all append local]
		   5]
		 #[0 "\300\301\302\303\304$\207"
		   [add-hook change-major-mode-hook
		    org-babel-show-result-all append local]
		   5]
		 org-babel-result-hide-spec
		 org-babel-hide-all-hashes org-eldoc-load)
 org-odt-format-drawer-function #[514 "\207" [] 3 "\n\n(fn NAME
 CONTENTS)"]
 org-archive-hook '(org-attach-archive-delete-maybe)
 org-confirm-elisp-link-function 'yes-or-no-p
 org-agenda-before-write-hook '(org-agenda-add-entry-text)
 org-metaup-hook '(org-babel-load-in-session-maybe)
 org-latex-format-drawer-function #[514 "\207" [] 3 "\n\n(fn _
 CONTENTS)"]
 org-babel-pre-tangle-hook '(save-buffer)
 org-tab-first-hook '(org-babel-hide-result-toggle-maybe
		      org-babel-header-arg-expand)
 org-babel-load-languages '((emacs-lisp . t) (R . t) (shell . t))
 org-ascii-format-drawer-function #[771 "\x01\207" [] 4 "\n\n(fn NAME
 CONTENTS WIDTH)"]
 org-occur-hook '(org-first-headline-recenter)
 org-cycle-hook '(org-cycle-hide-archived-subtrees
		  org-cycle-hide-drawers
		  org-cycle-show-empty-lines
		  org-optimize-window-after-visibility-change)
 org-speed-command-hook '(org-speed-command-default-hook
			  org-babel-speed-command-hook)
 org-odt-format-inlinetask-function
 'org-odt-format-inlinetask-default-function
 org-confirm-shell-link-function 'yes-or-no-p
 org-link-parameters '(("id" :follow org-id-open)
		       ("rmail" :follow org-rmail-open :store
			org-rmail-store-link)
		       ("mhe" :follow org-mhe-open :store
			org-mhe-store-link)
		       ("irc" :follow org-irc-visit :store
			org-irc-store-link)
		       ("info" :follow org-info-open :export
			org-info-export :store
			org-info-store-link)
		       ("gnus" :follow org-gnus-open :store
			org-gnus-store-link)
		       ("docview" :follow org-docview-open
			:export org-docview-export :store
			org-docview-store-link)
		       ("bibtex" :follow org-bibtex-open :store
			org-bibtex-store-link)
		       ("bbdb" :follow org-bbdb-open :export
			org-bbdb-export :complete
			org-bbdb-complete-link :store
			org-bbdb-store-link)
		       ("w3m" :store org-w3m-store-link)
		       ("file+sys") ("file+emacs")
		       ("doi" :follow org--open-doi-link)
		       ("elisp" :follow org--open-elisp-link)
		       ("file" :complete org-file-complete-link)
		       ("ftp" :follow
			(lambda (path)
			 (browse-url (concat "ftp:" path)))
			)
		       ("help" :follow org--open-help-link)
		       ("http" :follow
			(lambda (path)
			 (browse-url (concat "http:" path)))
			)
		       ("https" :follow
			(lambda (path)
			 (browse-url (concat "https:" path)))
			)
		       ("mailto" :follow
			(lambda (path)
			 (browse-url (concat "mailto:" path)))
			)
		       ("message" :follow
			(lambda (path)
			 (browse-url (concat "message:" path)))
			)
		       ("news" :follow
			(lambda (path)
			 (browse-url (concat "news:" path)))
			)
		       ("shell" :follow org--open-shell-link))
 org-latex-format-headline-function
 'org-latex-format-headline-default-function
 org-latex-format-inlinetask-function
 'org-latex-format-inlinetask-default-function
 org-html-format-drawer-function #[514 "\207" [] 3 "\n\n(fn NAME
 CONTENTS)"]
 org-latex-packages-alist '(("usenames,dvipsnames" "color" nil)
			    ("" "listings" nil))
 org-html-format-headline-function
 'org-html-format-headline-default-function
 org-latex-listings-options '(("backgroundcolor"
			       "\\color[gray]{0.95}")
			      ("keywordstyle" "\\color{blue}")
			      ("commentstyle"
			       "\\color{BrickRed}")
			      ("stringstyle" "\\color{Red}")
			      ("keepspaces" "true")
			      ("deletekeywords" "{ps,scan}"))
 )

Re: exporting inline source code with listings broken by color commands

[Nicolas Goaziou]

Hello,

Tyler Smith <tyler@plantarum.ca> writes:

> (setq org-latex-listings t
>       org-latex-listings-options
>       '(("backgroundcolor" "\\color[gray]{0.95}")

This is incorrect. Per "listings" manual, a commend with an optional
argument needs to be included within curly braces:

  ("backgroundcolor" "{\\color[gray]{0.95}}")
  
> Then open tmp.org, which contains the following:
>
> # -*- org-export-babel-evaluate: nil -*-

[...]

>   Inline code: src_R{1 + 1} {{{results(=2=)}}}
>
>
> Export to pdf via C-c C-e l o
>
> What I expect to happen is that the last line is rendered as "Inline
> code: 2".

This is not going to happen. Since you set `org-export-babel-evaluate'
to nil, you have a somewhat WYSIWYG behaviour; the "1 + 1" is not going
to disapper.

You may want to use ":eval never-export" in conjuction with ":exports
results", e.g.,

  #+property: header-args :eval never-export
  Inline code: src_R[:exports results]{1 + 1} {{{results(=2=)}}}


Regards,

-- 
Nicolas Goaziou

Re: exporting inline source code with listings broken by color commands

[Tyler Smith]

Nicolas Goaziou writes:

> Hello,
>
> Tyler Smith <tyler@plantarum.ca> writes:
>
>> (setq org-latex-listings t
>>       org-latex-listings-options
>>       '(("backgroundcolor" "\\color[gray]{0.95}")
>
> This is incorrect. Per "listings" manual, a commend with an optional
> argument needs to be included within curly braces:
>
>   ("backgroundcolor" "{\\color[gray]{0.95}}")

Aha! That was my mistake. The fact that that syntax worked for
lstlistings, or at least appeared to be less obviously broken, and not
in lstinline confused me.

>>
>> What I expect to happen is that the last line is rendered as "Inline
>> code: 2".
>
> This is not going to happen. Since you set `org-export-babel-evaluate'
> to nil, you have a somewhat WYSIWYG behaviour; the "1 + 1" is not going
> to disapper.

Echoing the source code wasn't my concern here; rather it was the
display of several lines of broken LaTeX code. The correction above
fixes this, so now I can tweak the evaluation and export settings with a
reasonable chance of success.

Thanks for your help!

Tyler