Torque
  1. Torque
  2. TORQUE-71

custom velocity renderer to have nicely trimmed generated code

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.3-RC3
    • Component/s: Generator
    • Labels:
      None

      Description

      The current Torque templates have spaces and tabs in front of Velocity commands (#foreach, #set, #end,...). The Velocity renderer puts this spaces and tabs into the generated code - that is the reason why the code in generated Base* class files looks sometimes a little bit ugly. If we remove the leading spaces in front of Velocity commands we can avoid this problem.

      My solution is to override the rendering method in org.apache.velocity.texen.ant.TexenTask that Torque uses to render the templates and replace the template loader with our own. Therefor we can remove the leading spaces.

      /**

      • This method filters the template and replaces some
      • unwanted characters. For example it removes leading
      • spaces in front of velocity commands and replaces
      • tabs with spaces to prevent bounces in different
      • code editors with different tab-width-setting.
        */
        protected byte[] filter(String template, String encoding) throws Exception {
        StringReader stringReader = new StringReader(template);
        LineNumberReader lineNumberReader = new LineNumberReader(stringReader);
        String line = null;
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        PrintStream ps = new PrintStream(baos,true,encoding);

      while ((line = lineNumberReader.readLine()) != null)

      { // remove leading spaces in front of velocity commands and comments line = line.replaceAll("^\\s*#", "#"); // replace tabs with spaces to prevent bounces in editors line = line.replaceAll("\t"," "); ps.println(line); }

      ps.flush();
      ps.close();

      return baos.toByteArray();
      }

      The only problem is, that this would generate an error if you use empty statements in #if or #foreach commands, for example
      #if (something)
      #end

      This would create an error in velocity's render engine if you remove the leading spaces - because empty statements are not allowed in Velocity. But this can be avoided by add a single new line:

      #if (something)

      #end

      A patch for the current generator comes in the next days.

      1. TorqueDataModelTask.java
        24 kB
        Thomas Fox
      2. patch.txt
        30 kB
        Thoralf Rickert

        Activity

        Thoralf Rickert created issue -
        Thoralf Rickert made changes -
        Field Original Value New Value
        Attachment patch.txt [ 12346444 ]
        Thomas Fox made changes -
        Attachment TorqueDataModelTask.java [ 12366863 ]
        Thomas Fox made changes -
        Resolution Fixed [ 1 ]
        Fix Version/s 3.3-RC3 [ 12312398 ]
        Status Open [ 1 ] Closed [ 6 ]

          People

          • Assignee:
            Unassigned
            Reporter:
            Thoralf Rickert
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development