Examples of com.puppetlabs.xtext.dommodel.formatter.comments.CommentProcessor

Package com.puppetlabs.xtext.dommodel.formatter.comments

Examples of com.puppetlabs.xtext.dommodel.formatter.comments.CommentProcessor

com.puppetlabs.xtext.dommodel.formatter.comments.CommentProcessor
This comment processor is used to parse and format comments spanning multiple lines. It is a low-level class that can be used to implement higher order comment formatting strategies.

Comments may be a sequence of single line comments, or a multi line comment. When processing a sequence of single line comments, everything in the passed region to format must be comment text or whitespace - input in this example:
```
 # comment a = 10 # comment b = 20 # comment 
```
will result in something like:
```
 # comment # a = 10 # comment # b = 20 # comment # comment 
```
Usage: An instance of the class is created with an ICommentContext that describes how the comment should be parsed. This context includes the relative starting position of the comment sequence. One of the classes implementing this interface may be used as a convenience. As an example, given the text:
```
 {@code a = 10 / * comment starts here * and continues here, * but is not aligned ok and some lines do not start with the repeating character ∗/}
```
Is processed by providing the starting line offset 7. When formatting with the same context, the result is:
```
 {@code a = 10 / * comment starts here * and continues here * but is not aligned ok * and some lines do not start with the repeating character ∗/ }
```
To relocate the comment, or output it in a different style, use a second {@link ICommentContainerInformation} in the format call.The same input example as before can be output to look like this:
```
 {@code a = 10 # # comment starts here # and continues here # but is not aligned ok # and some lines do not start with the repeating character # }
```
The comment processor has special processing of comment lines that consists of the same repeated character. All such lines are formatted without a left margin, and such lines longer than 5 characters are truncated instead of folded/wrapped when not fitting within the max constraints.

It is possible to constrain trailing empty lines min/max.

Note that the result will contain leading whitespace up to the position passed as the starting position. When appending the text to an existing flow already at this position, the method {@link CharSequences#trimLeft(CharSequence)} can be used to adjust the text to this position.
TODO: Needs to know about the ICommentFormatterAdvice !


      ICommentContainerInformation in = (nodes.size() == 1 && nodes.get(0).getGrammarElement() == ga.getML_COMMENTRule())
          ? commentConfiguration.getContainerInformation(CommentType.Multiline)
          : (commentConfiguration.getContainerInformation(CommentType.SingleLine));


      CommentProcessor cpr = new CommentProcessor();
      CommentText comment = cpr.separateCommentFromContainer(result, in, "\n"); // TODO: cheating on line separator
      return new RubyDocProcessor().asHTML(comment.getLines());


    }
    return null;
  }

View Full Code Here

  @Test
  public void test_CommentProcessor() {
    CommentFormattingOptions options = new CommentFormattingOptions(
      new ICommentFormatterAdvice.DefaultCommentAdvice(), 80);
    JavaLikeMLCommentContainer in = new ICommentContainerInformation.JavaLikeMLCommentContainer(0);
    CommentProcessor cp = new CommentProcessor();
    String source = "/* the\nquick\n     *brown\n * fox\n   \n\n*/ ";
    IFormattingContext fmtCtx = get(IFormattingContext.class);
    TextFlow s = cp.formatComment(source, in, in, options, fmtCtx);
    String expected = "/* the\n * quick\n * brown\n * fox\n */ ";
    assertEquals("Should produce expected result", expected, s.getText().toString());
  }

View Full Code Here

  @Test
  public void test_CommentProcessor_bannerfolding() {
    CommentFormattingOptions options = new CommentFormattingOptions(
      new ICommentFormatterAdvice.DefaultCommentAdvice(), 24);
    JavaLikeMLCommentContainer in = new ICommentContainerInformation.JavaLikeMLCommentContainer(0);
    CommentProcessor cp = new CommentProcessor();


    String source = //
    "/*******************************************\n"//
        + "* 0123456789 0123456789 0123456789 0123456789\n"//
        + "* abc\n" //
        + "* 0123456789 0123456789 0123456789 0123456789\n"//
        + "*/";
    String expected = //
    "/***********************\n"//
        + " * 0123456789 0123456789\n * 0123456789 0123456789\n"//
        + " * abc\n" //
        + " * 0123456789 0123456789\n * 0123456789 0123456789\n"//
        + " */";
    IFormattingContext fmtCtx = get(IFormattingContext.class);
    TextFlow s = cp.formatComment(source, in, in, options, fmtCtx);
    assertEquals("Should produce expected result", expected, s.getText().toString());
  }

View Full Code Here

  @Test
  public void test_CommentProcessor_folding() {
    CommentFormattingOptions options = new CommentFormattingOptions(
      new ICommentFormatterAdvice.DefaultCommentAdvice(), 24);
    JavaLikeMLCommentContainer in = new ICommentContainerInformation.JavaLikeMLCommentContainer(0);
    CommentProcessor cp = new CommentProcessor();


    String source = //
    "/* 0123456789 0123456789 0123456789 0123456789\n"//
        + "* abc\n" //
        + "* 0123456789 0123456789 0123456789 0123456789\n"//
        + "*/";
    String expected = //
    "/* 0123456789 0123456789\n * 0123456789 0123456789\n"//
        + " * abc\n" //
        + " * 0123456789 0123456789\n * 0123456789 0123456789\n"//
        + " */";


    IFormattingContext fmtCtx = get(IFormattingContext.class);
    TextFlow s = cp.formatComment(source, in, in, options, fmtCtx);
    assertEquals("Should produce expected result", expected, s.getText().toString());
  }

View Full Code Here

  @Test
  public void test_CommentProcessor_folding_indent() {
    CommentFormattingOptions options = new CommentFormattingOptions(
      new ICommentFormatterAdvice.DefaultCommentAdvice(), 26);
    JavaLikeMLCommentContainer in = new ICommentContainerInformation.JavaLikeMLCommentContainer(0);
    CommentProcessor cp = new CommentProcessor();


    String source = //
    "/*   0123456789 0123456789 0123456789 0123456789\n"//
        + "* abc\n" //
        + "* 0123456789 0123456789 0123456789 0123456789\n"//
        + "*/";
    String expected = //
    "/*   0123456789 0123456789\n *   0123456789 0123456789\n"//
        + " * abc\n" //
        + " * 0123456789 0123456789\n * 0123456789 0123456789\n"//
        + " */";
    IFormattingContext fmtCtx = get(IFormattingContext.class);
    TextFlow s = cp.formatComment(source, in, in, options, fmtCtx);
    assertEquals("Should produce expected result", expected, s.getText().toString());
  }

View Full Code Here

  }


  @Test
  public void test_CommentProcessor_Indented() {
    JavaLikeMLCommentContainer in = new ICommentContainerInformation.JavaLikeMLCommentContainer(2);
    CommentProcessor cp = new CommentProcessor();
    CommentFormattingOptions options = new CommentFormattingOptions(
      new ICommentFormatterAdvice.DefaultCommentAdvice(), 80);
    String source = "/* the\n  quick\n       *brown\n   * fox\n     \n  \n  */ ";
    IFormattingContext fmtCtx = get(IFormattingContext.class);
    TextFlow s = cp.formatComment(source, in, in, options, fmtCtx);
    // pad expected and result with 2 spaces to emulate the inserting of the result
    // (makes comparison look nicer if test fails)
    String expected = "  /* the\n   * quick\n   * brown\n   * fox\n   */ ";
    assertEquals("Should produce expected result", expected, "  " + CharSequences.trimLeft(s.getText()).toString());
  }

View Full Code Here

        try {


          String issueString = xtextDocument.get(issue.getOffset(), issue.getLength());
          final boolean endsWithBreak = issue.getData() != null && issue.getData().length == 1 &&
              "true".equals(issue.getData()[0]);
          CommentProcessor commentProcessor = new CommentProcessor();
          JavaLikeMLCommentContainer mlContainer = new ICommentContainerInformation.JavaLikeMLCommentContainer();
          HashSLCommentContainer hashContainer = new ICommentContainerInformation.HashSLCommentContainer();
          int offsetOfNode = issue.getOffset();


          int posOnLine = offsetOfNode -
              Math.max(0, 1 + CharSequences.lastIndexOf(
                xtextDocument.get(0, xtextDocument.getLength()), "\n", offsetOfNode - 1));


          CommentText commentText = commentProcessor.separateCommentFromContainer(
            issueString, mlContainer.create(posOnLine), "\n");
          TextFlow result = commentProcessor.formatComment(
            commentText, hashContainer.create(posOnLine), new CommentFormattingOptions(
              commentConfigurationProvider.get().getFormatterAdvice(CommentType.SingleLine),
              Integer.MAX_VALUE, 0, 1), formattingContextFactory.create(state, FormattingOption.Format));


          if(!endsWithBreak)

View Full Code Here

TOP

Related Classes of com.puppetlabs.xtext.dommodel.formatter.comments.CommentProcessor

com.puppetlabs.geppetto.pp.dsl.tests.TestSemanticCssFormatter

com.puppetlabs.geppetto.pp.dsl.ui.editor.hover.PPDocumentationProvider

com.puppetlabs.geppetto.pp.dsl.ui.quickfix.PPQuickfixProvider

com.puppetlabs.xtext.textflow.TextFlow

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.