Merge pull request #7 from wikimedia/mathrm

Use mathrm instead of mbox for text literals

.travis.yml

@@ -1,6 +1,8 @@
 language: node_js
 node_js:
- - "0.10"
- - "0.8"
+ - "0.10"
+ - "0.12"
+ - "4.2"
+ - "iojs-v2.5.0"
 before_install:
  - npm install npm -g

README.md

@@ -93,9 +93,9 @@ Licensed under GPLv2.
 [NPM1]: https://nodei.co/npm/texvcjs.svg
 [NPM2]: https://nodei.co/npm/texvcjs/
 
-[1]: https://travis-ci.org/cscott/texvcjs.svg
-[2]: https://travis-ci.org/cscott/texvcjs
-[3]: https://david-dm.org/cscott/texvcjs.svg
-[4]: https://david-dm.org/cscott/texvcjs
-[5]: https://david-dm.org/cscott/texvcjs/dev-status.svg
-[6]: https://david-dm.org/cscott/texvcjs#info=devDependencies
+[1]: https://travis-ci.org/wikimedia/texvcjs.svg
+[2]: https://travis-ci.org/wikimedia/texvcjs
+[3]: https://david-dm.org/wikimedia/texvcjs.svg
+[4]: https://david-dm.org/wikimedia/texvcjs
+[5]: https://david-dm.org/wikimedia/texvcjs/dev-status.svg
+[6]: https://david-dm.org/wikimedia/texvcjs#info=devDependencies

bin/texvcjs

@@ -12,6 +12,7 @@ program
  .usage('[options] <tex input>')
  .option('--rebuild', 'Rebuild PEGjs grammar before parsing')
  .option('-v, --verbose', 'Show verbose error information')
+ .option('--usemathrm', 'Use \\mathrm instead of \\mbox to escape some text literals')
  .option('-D, --debug', 'Show stack trace on failure');
 
 PACKAGES.forEach(function(pkg) {
@@ -33,7 +34,7 @@ if (program.rebuild) {
 }
 
 var texvcjs = require('../');
-var result = texvcjs.check(input, { debug: program.debug });
+var result = texvcjs.check(input, { debug: program.debug, usemathrm:program.usemathrm });
 
 // check required packages
 PACKAGES.forEach(function(pkg) {

lib/index.js

@@ -29,9 +29,13 @@ var check = module.exports.check = function(input, options) {
  * command ...
  */
  try {
+ if( typeof options === "undefined" ){
+ options = {};
+ options.usemathrm = false;
+ }
  // allow user to pass a parsed AST as input, as well as a string
  if (typeof(input)==='string') {
- input = Parser.parse(input);
+ input = Parser.parse(input, {usemathrm:options.usemathrm});
  }
  var output = render(input);
  var result = { status: '+', output: output };

lib/parser.pegjs

@@ -253,12 +253,18 @@ LITERAL
  { return ast.RenderT.TEX_ONLY("\\operatorname {" + f.slice(1) + "}" + c); }
  / f:generic_func &{ return tu.other_literals1[f]; } _ // from Texutil.find(...)
  { return ast.RenderT.TEX_ONLY(f + " "); }
+ / f:generic_func &{ return options.usemathrm && tu.other_literals2[f]; } _ // from Texutil.find(...)
+ { return ast.RenderT.TEX_ONLY("\\mathrm {" + f + "} "); }
+ / mathrm:generic_func &{ return options.usemathrm && mathrm === "\\mathrm"; } _
+ "{" f:generic_func &{ return options.usemathrm && tu.other_literals2[f]; } _ "}" _
+ /* make sure we can parse what we emit */
+ { return options.usemathrm && ast.RenderT.TEX_ONLY("\\mathrm {" + f + "} "); }
  / f:generic_func &{ return tu.other_literals2[f]; } _ // from Texutil.find(...)
  { return ast.RenderT.TEX_ONLY("\\mbox{" + f + "} "); }
  / mbox:generic_func &{ return mbox === "\\mbox"; } _
  "{" f:generic_func &{ return tu.other_literals2[f]; } _ "}" _
-  /* make sure we can parse what we emit */
-  { return ast.RenderT.TEX_ONLY("\\mbox{" + f + "} "); }
+ /* make sure we can parse what we emit */
+ { return ast.RenderT.TEX_ONLY("\\mbox{" + f + "} "); }
  / f:(COLOR / DEFINECOLOR)
  { return ast.RenderT.TEX_ONLY(f); }
  / "\\" c:[, ;!_#%$&] _

package.json

@@ -21,11 +21,11 @@
  "url": "https:/cscott/texvcjs/issues"
  },
  "dependencies": {
- "commander": "~2.5.0"
+ "commander": "~2.9.0"
  },
  "devDependencies": {
- "jshint": "~2.5.2",
- "mocha": "~2.0.1",
+ "jshint": "~2.8.0",
+ "mocha": "~2.3.3",
  "pegjs": "~0.8.0"
  },
  "bin": {

test/all.js

@@ -178,6 +178,34 @@ describe('Comprehensive test cases', function() {
  '\\mbox{\\varstigma} ',
  skipOcaml: true
  },
+ 'Literals (2) MJ': {
+ usemathrm: true,
+ input:
+ '\\AA\\Coppa\\coppa\\Digamma\\euro\\geneuro\\geneuronarrow' +
+ '\\geneurowide\\Koppa\\koppa\\officialeuro\\Sampi\\sampi' +
+ '\\Stigma\\stigma\\textvisiblespace\\varstigma',
+ output:
+ '\\mathrm {\\AA} \\mathrm {\\Coppa} \\mathrm {\\coppa} ' +
+ '\\mathrm {\\Digamma} \\mathrm {\\euro} \\mathrm {\\geneuro} ' +
+ '\\mathrm {\\geneuronarrow} \\mathrm {\\geneurowide} ' +
+ '\\mathrm {\\Koppa} \\mathrm {\\koppa} \\mathrm {\\officialeuro} ' +
+ '\\mathrm {\\Sampi} \\mathrm {\\sampi} \\mathrm {\\Stigma} ' +
+ '\\mathrm {\\stigma} \\mathrm {\\textvisiblespace} ' +
+ '\\mathrm {\\varstigma} '
+ },
+ 'Literals (2\') MJ': {
+ usemathrm:true,
+ /* We can parse what we emit (but the ocaml version can't) */
+ input:
+ '\\mathrm {\\AA} \\mathrm {\\Coppa} \\mathrm {\\coppa} ' +
+ '\\mathrm {\\Digamma} \\mathrm {\\euro} \\mathrm {\\geneuro} ' +
+ '\\mathrm {\\geneuronarrow} \\mathrm {\\geneurowide} ' +
+ '\\mathrm {\\Koppa} \\mathrm {\\koppa} \\mathrm {\\officialeuro} ' +
+ '\\mathrm {\\Sampi} \\mathrm {\\sampi} \\mathrm {\\Stigma} ' +
+ '\\mathrm {\\stigma} \\mathrm {\\textvisiblespace} ' +
+ '\\mathrm {\\varstigma} ',
+ skipOcaml: true
+ },
  'Literals (3)': {
  input:
  '\\C\\H\\N\\Q\\R\\Z\\alef\\alefsym\\Alpha\\and\\ang\\Beta' +
@@ -422,7 +450,7 @@ describe('Comprehensive test cases', function() {
  tc.output = tc.output || tc.input;
  if (!tc.skipJs) {
  it('output should be correct', function() {
- var result = texvcjs.check(tc.input, { debug: true });
+ var result = texvcjs.check(tc.input, { debug: true, usemathrm:tc.usemathrm});
  assert.equal(result.status, '+');
  assert.equal(result.output, tc.output);
  });

test/mathjax-texvc.js

@@ -14,7 +14,7 @@ describe('Run test for all mathjax-texvc commands:', function () {
  formulae.forEach(function (testcase) {
  if(testcase.ignore !== true ) {
  it(testcase.id+"$"+testcase.input+"$", function () {
- var result = texvcjs.check(testcase.input);
+ var result = texvcjs.check(testcase.input,{usemathrm:true});
  assert.equal(result.output, testcase.texvcjs,
  JSON.stringify({
  id: testcase.id,

test/mathjax-texvc.json

@@ -7,17 +7,17 @@
  {
  "id": 2,
  "input": "\\koppa",
- "texvcjs": "\\mbox{\\koppa} "
+ "texvcjs": "\\mathrm {\\koppa} "
  },
  {
  "id": 3,
  "input": "\\stigma",
- "texvcjs": "\\mbox{\\stigma} "
+ "texvcjs": "\\mathrm {\\stigma} "
  },
  {
  "id": 4,
  "input": "\\coppa",
- "texvcjs": "\\mbox{\\coppa} "
+ "texvcjs": "\\mathrm {\\coppa} "
  },
  {
  "id": 5,
@@ -87,7 +87,7 @@
  {
  "id": 18,
  "input": "\\AA",
- "texvcjs": "\\mbox{\\AA} "
+ "texvcjs": "\\mathrm {\\AA} "
  },
  {
  "id": 19,
@@ -162,7 +162,7 @@
  {
  "id": 33,
  "input": "\\textvisiblespace",
- "texvcjs": "\\mbox{\\textvisiblespace} "
+ "texvcjs": "\\mathrm {\\textvisiblespace} "
  },
  {
  "id": 34,
@@ -365,17 +365,17 @@
  {
  "id": 73,
  "input": "\\Koppa",
- "texvcjs": "\\mbox{\\Koppa} "
+ "texvcjs": "\\mathrm {\\Koppa} "
  },
  {
  "id": 74,
  "input": "\\Stigma",
- "texvcjs": "\\mbox{\\Stigma} "
+ "texvcjs": "\\mathrm {\\Stigma} "
  },
  {
  "id": 75,
  "input": "\\Coppa",
- "texvcjs": "\\mbox{\\Coppa} "
+ "texvcjs": "\\mathrm {\\Coppa} "
  },
  {
  "id": 76,
@@ -451,8 +451,8 @@
  },
  {
  "id": 90,
- "input": "\\pagecolor{red}",
- "texvcjs": "\\pagecolor {red}"
+ "input": "\\pagecolor{red}x",
+ "texvcjs": "\\pagecolor {red}x"
  },
  {
  "id": 91,