[The "BSD licence"]

Copyright (c) 2005-2006 Terence Parr

All rights reserved.

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions

are met:

1. Redistributions of source code must retain the above copyright

    notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright

    notice, this list of conditions and the following disclaimer in the

    documentation and/or other materials provided with the distribution.

3. The name of the author may not be used to endorse or promote products

    derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR

IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,

INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF

THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

*  translation, assume the Java target.  This is still a great test

*  for the semantics of the $x.y stuff regardless of the target.

*/

  /** Public default constructor used by TestRig */

  public TestAttributes() {

  }

  @Test public void testEscapedLessThanInAction() throws Exception {

    Grammar g = new Grammar();

    Tool antlr = newTool();

    CodeGenerator generator = new CodeGenerator(antlr, g, "Java");

    String action = "i<3; '<xmltag>'";

    ActionTranslator translator = new ActionTranslator(generator,"a",

                                   new antlr.CommonToken(ANTLRParser.ACTION,action),0);

    String expecting = action;

    String rawTranslation =

      translator.translate();

    StringTemplateGroup templates =

      new StringTemplateGroup(".", AngleBracketTemplateLexer.class);

    StringTemplate actionST = new StringTemplate(templates, "<action>");

    actionST.setAttribute("action", rawTranslation);

    String found = actionST.toString();

    assertEquals(expecting, found);

  }

  @Test public void testEscaped$InAction() throws Exception {

    String action = "int \\$n; \"\\$in string\\$\"";

    String expecting = "int $n; \"$in string$\"";

    Grammar g = new Grammar(

      "parser grammar t;\n"+

      "@members {"+action+"}\n"+

      "a[User u, int i]\n" +

      "        : {"+action+"}\n" +

      "        ;");

    Tool antlr = newTool();

    CodeGenerator generator = new CodeGenerator(antlr, g, "Java");

    g.setCodeGenerator(generator);

    generator.genRecognizer(); // forces load of templates

    ActionTranslator translator =

      new ActionTranslator(generator,

                    "a",

                    new antlr.CommonToken(ANTLRParser.ACTION,action),0);

    String rawTranslation =

      translator.translate();

    StringTemplateGroup templates =

      new StringTemplateGroup(".", AngleBracketTemplateLexer.class);

    StringTemplate actionST = new StringTemplate(templates, rawTranslation);

    String found = actionST.toString();

    assertEquals(expecting, found);

  }

  @Test public void testArguments() throws Exception {

    String action = "$i; $i.x; $u; $u.x";

    String expecting = "i; i.x; u; u.x";

    ErrorQueue equeue = new ErrorQueue();

    ErrorManager.setErrorListener(equeue);

    Grammar g = new Grammar(

      "parser grammar t;\n"+

      "a[User u, int i]\n" +

      "        : {"+action+"}\n" +

      "        ;");

    Tool antlr = newTool();

    CodeGenerator generator = new CodeGenerator(antlr, g, "Java");

    g.setCodeGenerator(generator);

    generator.genRecognizer(); // forces load of templates

    ActionTranslator translator = new ActionTranslator(generator,"a",

                                   new antlr.CommonToken(ANTLRParser.ACTION,action),1);

    String rawTranslation =

      translator.translate();

    StringTemplateGroup templates =

      new StringTemplateGroup(".", AngleBracketTemplateLexer.class);

    StringTemplate actionST = new StringTemplate(templates, rawTranslation);

    String found = actionST.toString();

    assertEquals(expecting, found);

    assertEquals("unexpected errors: "+equeue, 0, equeue.errors.size());

  }

  @Test public void testComplicatedArgParsing() throws Exception {

    String action = "x, (*a).foo(21,33), 3.2+1, '\\n', "+

            "\"a,oo\\nick\", {bl, \"fdkj\"eck}";

    String expecting = "x, (*a).foo(21,33), 3.2+1, '\\n', \"a,oo\\nick\", {bl, \"fdkj\"eck}";

    ErrorQueue equeue = new ErrorQueue();

    ErrorManager.setErrorListener(equeue);

    // now check in actual grammar.

    Grammar g = new Grammar(

      "parser grammar t;\n"+

      "a[User u, int i]\n" +

      "        : A a["+action+"] B\n" +

      "        ;");

    Tool antlr = newTool();

    CodeGenerator generator = new CodeGenerator(antlr, g, "Java");

    g.setCodeGenerator(generator);

    generator.genRecognizer(); // forces load of templates

    ActionTranslator translator = new ActionTranslator(generator,"a",

                                   new antlr.CommonToken(ANTLRParser.ACTION,action),1);

    String rawTranslation =  translator.translate();

    assertEquals(expecting, rawTranslation);

    assertEquals("unexpected errors: "+equeue, 0, equeue.errors.size());

  }

  @Test public void testBracketArgParsing() throws Exception {

    ErrorQueue equeue = new ErrorQueue();

    ErrorManager.setErrorListener(equeue);

    // now check in actual grammar.

    Grammar g = new Grammar(

      "parser grammar t;\n"+

      "a[String[\\] ick, int i]\n" +

      "        : A \n"+

      "        ;");

    Tool antlr = newTool();

    CodeGenerator generator = new CodeGenerator(antlr, g, "Java");

    g.setCodeGenerator(generator);

    generator.genRecognizer(); // forces load of templates

    Rule r = g.getRule("a");

    AttributeScope parameters = r.parameterScope;

    List<Attribute> attrs = parameters.getAttributes();

    assertEquals("attribute mismatch","String[] ick",attrs.get(0).decl.toString());

    assertEquals("parameter name mismatch","ick",attrs.get(0).name);

    assertEquals("declarator mismatch", "String[]", attrs.get(0).type);

    assertEquals("attribute mismatch","int i",attrs.get(1).decl.toString());

    assertEquals("parameter name mismatch","i",attrs.get(1).name);

    assertEquals("declarator mismatch", "int", attrs.get(1).type);

    assertEquals("unexpected errors: "+equeue, 0, equeue.errors.size());

  }

  @Test public void testStringArgParsing() throws Exception {

    String action = "34, '{', \"it's<\", '\"', \"\\\"\", 19";

    String expecting = "34, '{', \"it's<\", '\"', \"\\\"\", 19";

    ErrorQueue equeue = new ErrorQueue();

    ErrorManager.setErrorListener(equeue);

    // now check in actual grammar.

    Grammar g = new Grammar(

      "parser grammar t;\n"+

      "a[User u, int i]\n" +

      "        : A a["+action+"] B\n" +

      "        ;");

    Tool antlr = newTool();

    CodeGenerator generator = new CodeGenerator(antlr, g, "Java");

    g.setCodeGenerator(generator);

    generator.genRecognizer(); // forces load of templates

    ActionTranslator translator = new ActionTranslator(generator,"a",

                                   new antlr.CommonToken(ANTLRParser.ACTION,action),1);

    String rawTranslation =  translator.translate();

    assertEquals(expecting, rawTranslation);

    List<String> expectArgs = new ArrayList<String>() {

      {add("34");}

      {add("'{'");}

      {add("\"it's<\"");}

      {add("'\"'");}

      {add("\"\\\"\"");} // that's "\""

      {add("19");}

    };

    List<String> actualArgs = CodeGenerator.getListOfArgumentsFromAction(action, ',');

    assertEquals("args mismatch", expectArgs, actualArgs);

    assertEquals("unexpected errors: "+equeue, 0, equeue.errors.size());

  }

  @Test public void testComplicatedSingleArgParsing() throws Exception {

    String action = "(*a).foo(21,33,\",\")";

    String expecting = "(*a).foo(21,33,\",\")";

    ErrorQueue equeue = new ErrorQueue();

    ErrorManager.setErrorListener(equeue);

    // now check in actual grammar.

    Grammar g = new Grammar(

      "parser grammar t;\n"+

      "a[User u, int i]\n" +

      "        : A a["+action+"] B\n" +

      "        ;");

    Tool antlr = newTool();

    CodeGenerator generator = new CodeGenerator(antlr, g, "Java");

    g.setCodeGenerator(generator);

    generator.genRecognizer(); // forces load of templates

    ActionTranslator translator = new ActionTranslator(generator,"a",

                                   new antlr.CommonToken(ANTLRParser.ACTION,action),1);

    String rawTranslation =  translator.translate();

    assertEquals(expecting, rawTranslation);

    assertEquals("unexpected errors: "+equeue, 0, equeue.errors.size());

  }

  @Test public void testArgWithLT() throws Exception {

    String action = "34<50";

    String expecting = "34<50";

    ErrorQueue equeue = new ErrorQueue();

    ErrorManager.setErrorListener(equeue);

    // now check in actual grammar.

    Grammar g = new Grammar(

      "parser grammar t;\n"+

      "a[boolean b]\n" +

      "        : A a["+action+"] B\n" +

      "        ;");