MenuExplore! Impressum Privacy Policy
☐
Create minimal Java grammar for this project in order to make code less complex

Tasks

Done Tasks

  • [x] Make grammar clean, so it's straight forward to process for translations and to understand.
  • [x] Add such check to build system, so that grammar compliance is enforced.
    • [x] Create command to check all repos and projects.
    • [o] Check command has to provide all project paths to the source code checker and the source code checker has to be independent of current folder. -> Integration into the Maven build process does this better.
    • [x] Create Maven build plugin.
      • [x] Copy Java grammar code into net.splitcells.dem.source.
      • [x] Add source code check to Maven plugin via net.splitcells.dem.source.
      • [x] Delete Java grammar code from net.splitcells.dem.
      • [x] Adjust packages in new net.splitcells.dem.source project.
    • [x] Make source code completely compliant and after that, convert all grammar errors from error messages to build failures. mci -Dsource_code_check=true -DskipTests is used to optionally enable the source code check.
  • [o] Add Java's record type to the allowed grammar. -> This is not needed for now.
  • [x] Make code compliant to grammar again.
  • [x] Avoid grammar check if JavaLegacyArtifact is present, because it destroys the error messages of ANTLR4.
  • [o] Check grammar for all repos. -> There is no need for such command. It's best to add this to the build process.
    • [o] Create equivalent to repo process, but for projects.
    • [o] Create net.splitcells.project.process project, in order to process such projects.
    • [o] Move net.splitcells.project.files.standard content into net.splitcells.project.process and delete original. This way a generic project exists for such things and improves the existing project name, which is too long.
  • [x] Create alternative implementations for all Domable#toDom instances.
  • [x] Fix grammar error, that causes ANTLR4 to not show, what the grammar error. -> Found a workaround: The rule (.)*? Keysymbol_at Keyword_JavaLegacyArtifact (.)*? EOF breaks every error message. Disabling this rule for a file in question creates normal error messages.
    • [x] Print out lexer's tokens result on error. Maybe that is enough? https://stackoverflow.com/questions/70701595/is-there-a-way-to-extract-tokens-in-order-with-antlr
    • [x] Maybe try out ANTLR4 UI first.
  • [x] Remove usage of `org.w3c, because of the problems associated with this lib.
    • [x] Remove usage of Domable#toDom except inside Domable#toDom implementations.
      • [x] toDom is used in order to implement toDom like functions like Constraint#graph.
      • [x] Remove other toDom usage.
        • [x] Update Rater#argumentation(GroupId, Table).
          • [x] Test whether Rater#argumentation(GroupId, Table) is used at all. -> No it is not really used. So We can replace the method in one go or commit. We could even delete it with no issue, but it may have a need, that is forgotten, so we just convert it instead. Rater#argumentation(GroupId, Table) does not have anything to do with Constraint#naturalArgumentation() and co.
          • [x] Create test for argumentation. -> Is not needed
          • [x] Remove Rater#argumentation(GroupId, Table) from Rater interface.
          • [x] Convert all Rater#argumentation(GroupId, Table) overrides to normal methods, that use Perspective instead.
        • [x] Update Solution#createAnalysis.
          • [x] Convert Constraint#toDom()
            • [x] Remove method usage.
          • [x] Convert Constraint#graph()
        • [x] Convert SolutionView#toFodsTableAnalysis via toFodsTableAnalysis2. This is tested via SolutionTest#testToFodsTableAnalysis2.
          • [x] Convert SolutionView#toLinesFodsAnalysis via toLinesFodsAnalysis2.
            • [x] Use Perspective#toXmlString(XmlConfig). See empty-0.xml and empty-1.xml.
              • [x] Render splitcells.net namespaces correctly.
                • [x] xmlns:nt="http://splitcells.net/text.xsd"
                • [x] xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0"
                • [x] xmlns:str="http://splitcells.net/string.xsd"
            • [x] Ensure, that header is written correctly. See example.
              • [x] Create Perspective#toXmlString with config object, that is extensible.
            • [x] Render some Perspective properties as XML properties.
              • [x] Encode the fact, that something is an attribute in the NameSpace. Add the attribute isXmlAttribute. In order to support some values in an XML namespace -> This is done via Perspective#withXmlAttribute which encodes XML attributes with Perspectives of the new XML_SYNTAX namespace. isXmlAttribute is not needed.
              • [x] style-name
              • [x] XML_ATTRIBUTE
              • [x] FODS_STYLE
                • [x] name
                • [x] family
                • [x] parent-style-name
              • [x] FODS_FO
                • [x] background-color
                • [x] color
              • [x] FODS_OFFICE mimetype
              • [x] FODS_TABLE name
          • [x] Convert fodsStyling via fodsStyling2.
          • [x] Convert fodsStyling_style via fodsStyling_style2.
          • [x] Convert attributesOfFodsAnalysis via attributesOfFodsAnalysis2.
        • [x] Convert Table#toFods()
          • [o] The result is not operable in LibreOffice. -> This was a user error.
          • [o] The result SolutionView#toLinesFodsAnalysis of is not operable in LibreOffice as well. -> This was a user error. This migrated method worked previously.
        • [x] Convert History#toAnalysisFods via toAnalysisFods2.
          • [x] Create a test for this.
        • [x] Update ProjectsRendererI#createLayout.
          • [o] Create a test for this. -> Existing implicit tests are enough for now.
        • [x] Convert FodsUtility#tableCell
    • [x] Remove Domable#toDom API and implementation.
    • [x] Remove Java's XML imports.
      • [x] org.w3c
    • [x] Disallow XML imports in Java grammar by default.
  • [x] Ensure that Dem complies with new custom Java grammar.
  • [x] Detailed Javadoc grammar. -> task is migrated into repo and will be done later.
  • [x] Review grammar.
  • [x] Disable checks for bootstrap code. -> In the grammar it is called legacy code.
  • [x] Split up Dem into core and merger.
  • [x] Add grammar check to CI build. -> Source code check was added to capabilities check.
  • [x] Fix usage fragments. Currently, they often do not work and require Tokens for matches and the respective Regex do not work.
  • [x] Use mixed grammar, which makes it possible to used fragment tokens more effectively (currently these are broken). -> Split up grammars are better, because lexer work in ANTLR more like validator if one ignores string patterns.
  • [x] Remove explicit whitespace matches.
  • [x] Document how to do non combined grammar.
  • [x] Document how to do combined grammar. -> Not needed.
  • [x] Use upper case for Keywords in Lexer.
  • [x] Use constants in parser instead of tokens, in order to make these 2 more independent of each other. -> This does not have a real advantage.
  • [x] Reformat grammar source code.
  • [x] Create core project for Dem in order to test interface and implementation splitting.
  • [x] Test speed up via using faster alternatives for data structures: Maps, Sets, Lists -> What is this?
  • [x] Only allow foreign code import like the Java standard library in Java legacy code with some exceptions to the Java standard library like java.util.List. Currently, only Java standard library imports are blocked.
  • [x] Let all source code comply with this Java subset grammar.

Tasks For Future Tickets

  • [x] Check via Java-Parser the usage of standard library things, that do not require an import. Some of these need to be disallowed as well, as the existing does not support looking up things in Java's classpath. -> This task was moved into the README of net.splitcells.dem.source.
  • [ ] Remove direct usage of Path (because resolve method allows resolving absolute paths), Files (because changing the backend does not seem to be viable) and similar in the future.
  • [o] Make main part GPL compliant and only extensions non GPL compliant. -> This task description does not make sense to me.

Quotes

FODS-Header

<?xml version="1.0" encoding="UTF-8"?>
<office:document xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0"
                 xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0"
                 xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0"
                 office:mimetype="application/vnd.oasis.opendocument.spreadsheet">