MARTe2 » MARTe2-core

Implement a json and xml parser based on the SLK implementation.

h1. Source code files modified

* Source/Core/BareMetal/L3Streams/AdvancedErrorManagement.h
* Source/Core/BareMetal/L4Configuration/AnyTypeCreator.cpp
* Source/Core/BareMetal/L4Configuration/AnyTypeCreator.h
* Source/Core/BareMetal/L4Configuration/JsonParser.cpp
* Source/Core/BareMetal/L4Configuration/JsonParser.h
* Source/Core/BareMetal/L4Configuration/LexicalAnalyzer.cpp
* Source/Core/BareMetal/L4Configuration/LexicalAnalyzer.h
* Source/Core/BareMetal/L4Configuration/Parser.cpp
* Source/Core/BareMetal/L4Configuration/ParserI.cpp
* Source/Core/BareMetal/L4Configuration/ParserI.h
* Source/Core/BareMetal/L4Configuration/StandardParser.cpp
* Source/Core/BareMetal/L4Configuration/StandardParser.h
* Source/Core/BareMetal/L4Configuration/StringToInteger.cpp
* Source/Core/BareMetal/L4Configuration/XMLParser.cpp
* Source/Core/BareMetal/L4Configuration/XMLParser.h
* Source/Core/BareMetal/L4Configuration/ParserGrammar.h

h1. Source code files removed

* The files /Source/Core/BareMetal/L4Configuration/*.ll have been removed after archiving a copy of them on "MARTe2 (doc-git)" repository.

h1. Architecture & design review

N/A

h1. Code and documentation review

*Date of the review:* 18/12/2015 17/12/2015

*Person who did the review:* Ivan Herrero and Andre' Neto (second revision)

*Result of review:* PASS (but see non-conformities to be discussed in the next sprint) FAIL

*List of non-conformities:*

* The ParserGrammar class is not related to parsing analysis, but to lexical analysis, so it should be renamed accordingly.
* The ParserGrammar.h file defines three global constants of type ParserGrammar (StandardGrammar, XMLGrammar, and JsonGrammar). This file should not define them because it should be independent of any actual ParserGrammar instance (i.e. if we want to add a new parser class, we should have no need of modifying this file). So, it would be better if these constants are moved to the parser classes (StandardParser, XMLParser, and JsonParser).
* The ParserI and LexicalAnalyzer classes receive a stream by reference (StreamI&) on its constructor, but both store internally the address of the stream and use it as an explicit pointer, and accessing it on other functions. From the point of view of the user of the class, passing by reference a parameter in a function means that the object will be only accessed during the execution of the function (constructor in this case), but not during the lifetime of the instance of the class. It should be better declaring it as an explicit pointer on the constructor.
* The Parser class should be removed from the project. This implies removing source and unit test code (i.e. Parser, ParserTest, and ParserGTest), and updating makefiles. However, removing Parser and ParserTest is not straightforward, because the ParserTest is used by JsonParserTest and XMLParserTest, so it will need a refactoring of the unit tests for XML and JSON parsers. Remember to archive a copy of these files into "MARTe2 (doc-git)" before deleting it.
* DirectoryScannerTest.cpp does not compile on Windows because this branch lacks the file 'Environment/Windows/DirectoryCore.h'.
* The class AnyTypeCreator lacks the @details tag.
* The class ParserGrammar lacks the @details tag.

h1. Unit test review

*Date of the review:* 18/12/2015 17/12/2015

*Person who did the review:* Ivan Herrero Molina

*Result of coverage tests review:* PASS [PASS/FAIL]

*Result of functional tests review:* PASS

*Result of review:* PASS [PASS/FAIL]

*List of non-conformities:*

It lacks execute it on F4E Linux machine for coverage analysis.