mirror of
https://github.com/lucaspalomodevelop/indico-plugins.git
synced 2026-03-12 23:27:22 +00:00
74 lines
2.8 KiB
Python
74 lines
2.8 KiB
Python
# This file is part of Indico.
|
|
# Copyright (C) 2002 - 2017 European Organization for Nuclear Research (CERN).
|
|
#
|
|
# Indico is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU General Public License as
|
|
# published by the Free Software Foundation; either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# Indico is distributed in the hope that it will be useful, but
|
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
# General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Indico; if not, see <http://www.gnu.org/licenses/>.
|
|
|
|
"""
|
|
This preprocessor marks cells' metadata so that the appropriate highlighter can be used in the `highlight` filter.
|
|
|
|
More precisely, the language of a cell is set to C++ in two scenarios:
|
|
- Python notebooks: cells with `%%cpp` or `%%dcl` magic extensions.
|
|
- ROOT prompt C++ notebooks: all cells.
|
|
This preprocessor relies on the metadata section of the notebook to find out about the notebook's language.
|
|
|
|
Code courtesy of the ROOT project (https://root.cern.ch).
|
|
"""
|
|
|
|
import re
|
|
from nbconvert.preprocessors.base import Preprocessor
|
|
|
|
|
|
class CppHighlighter(Preprocessor):
|
|
|
|
"""Detects and tags code cells that use the C++ language."""
|
|
|
|
magics = ['%%cpp', '%%dcl']
|
|
cpp = 'cpp'
|
|
python = 'python'
|
|
|
|
def __init__(self, config=None, **kw):
|
|
super(CppHighlighter, self).__init__(config=config, **kw)
|
|
|
|
# Build regular expressions to catch language extensions or switches and choose
|
|
# an adequate pygments lexer
|
|
any_magic = "|".join(self.magics)
|
|
self.re_magic_language = re.compile(r"^\s*({0}).*".format(any_magic), re.DOTALL)
|
|
|
|
def matches(self, source, reg_expr):
|
|
return bool(reg_expr.match(source))
|
|
|
|
def _preprocess_cell_python(self, cell, resources, cell_index):
|
|
# Mark %%cpp and %%dcl code cells as cpp
|
|
if cell.cell_type == "code" and self.matches(cell.source, self.re_magic_language):
|
|
cell['metadata']['magics_language'] = self.cpp
|
|
|
|
return cell, resources
|
|
|
|
def _preprocess_cell_cpp(self, cell, resources, cell_index):
|
|
# Mark all code cells as cpp
|
|
if cell.cell_type == "code":
|
|
cell['metadata']['magics_language'] = self.cpp
|
|
|
|
return cell, resources
|
|
|
|
def preprocess(self, nb, resources):
|
|
self.preprocess_cell = self._preprocess_cell_python
|
|
try:
|
|
if nb.metadata.kernelspec.language == "c++":
|
|
self.preprocess_cell = self._preprocess_cell_cpp
|
|
except:
|
|
# if no language metadata, keep python as default
|
|
pass
|
|
return super(CppHighlighter, self).preprocess(nb, resources)
|