edu.rice.cs.drjava.model.definitions.indent

The tree is composed of {@link edu.rice.cs.drjava.model.definitions.indent.IndentRule}s, and asks a series of yes or no questions about the current position before determining the appropriate action. All nodes use helper methods from {@link edu.rice.cs.drjava.model.definitions.DefinitionsDocument} and the {@link edu.rice.cs.drjava.model.definitions.reducedmodel Reduced Model} package for context.

The tree itself is built in the {@link edu.rice.cs.drjava.model.definitions.indent.Indenter} class, where a singleton instance is made available to DefinitionsDocument for using on a single line. An outline of the tree is given below.

• 1. QuestionInsideComment
  
  • 2. Yes: QuestionPrevLineStartsComment
    
    • 3. Yes: QuestionCurrLineEmptyOrEnterPress
      Starting first line of a mutli-line comment
      • 4. Yes (no auto-close): ActionStartPrevLinePlus(" * ")
        Without auto-close comments, we always do the same thing.
      • 42. Yes (auto-close): QuestionFollowedByStar
        
        • 4. Yes: ActionStartPrevLinePlus(" * ")
          We are already inside a comment - no need to close it.
        • 41. No: ActionStartPrevLinePlusMultiline
                    (new String[] { " * \n", " */" }, 0, 3)
          We are starting a new block comment - close it.
      • 5. No: ActionStartPrevLinePlus(" ")
        Revisiting first line of a mutli-line comment
    • 6. No: QuestionPrevLineStartsWith("*")
      
      • 7. Yes: QuestionCurrLineStartsWith("*")
        
        • 8. Yes: ActionStartPrevLinePlus("") (Goto 12)
          Revisiting middle line of a mutli-line comment (with star)
        • 9. No: QuestionCurrLineEmptyOrEnterPress
          
          • 10. Yes: ActionStartPrevLinePlus("* ")
            Starting middle line of a mutli-line comment
          • 11. No: ActionStartPrevLinePlus("") (Goto 12)
            Revisiting middle line of a mutli-line comment (without star)
      • 12. No: ActionStartPrevLinePlus("")
        Following a line with no start in a mutli-line comment
  • 13. No: QuestionBraceIsParenOrBracket
    
    • 14. Yes: QuestionNewParenPhrase
      
      • 15. Yes: ActionBracePlus(" ")
      • 16. No: ActionBracePlus(" " + 1 level)
    • 17. No: QuestionBraceIsCurly
      
      • 18. Yes: QuestionCurrLineStartsWithSkipComments("}")
        
        • 19. Yes: ActionStartStmtOfBracePlus("")
        • 20. No: QuestionStartAfterOpenBrace
          
          • 21. Yes: ActionStartStmtOfBracePlus(1 level) (Goto 36)
          • 22. No: QuestionHasCharPrecedingOpenBrace
            
            • 23. Yes: ActionStartStmtOfBracePlus(1 level) (Goto 36)
            • 24. No: Goto 25.
      • 25. No: QuestionStartingNewStmt
        
        • 26. Yes: QuestionLineContains(":")
          
          • 27. Yes: QuestionExistsCharInStmt("?", ":")
            
            • 28. Yes: ActionStartPrevStmtPlus("", false) (Goto 30)
            • 29. No: ActionStartStmtOfBracePlus(1 level) (Goto 36)
          • 30. No: ActionStartPrevStmtPlus("", true)
        • 31. No: QuestionCurrLineStartsWithSkipComments("{")
          
          • 32. Yes: ActionStartCurrStmtPlus("")
          • 33. No: QuestionLineContains(":")
            
            • 34. Yes: QuestionExistsCharInStmt("?", ":")
              
              • 35. Yes: ActionStartCurrStmtPlus(1 level) (Goto 37)
              • 36. No: ActionStartStmtOfBracePlus(1 level)
            • 37. No: ActionStartCurrStmtPlus(1 level)

This question is useful for determining if, when a colon is found on a line, it is part of a ternary operator or not (construct this question with '?' for search character and ':' for end character).

It can also be used to determine if a statement contains a particular character by constructing it with the desired character as a search character and the end character as ';'.

Note that characters in comments and quotes are disregarded.