org.vishia.checkDeps_C

Class CheckDependencyFile

java.lang.Object

org.vishia.checkDeps_C.CheckDependencyFile

public class CheckDependencyFile
extends java.lang.Object

This class contains the methods to check one source file with its dependencies. The main routine is #processIncludeLine(String, String, AddDependency_InfoFileDependencies, ObjectFileDeps, TreeMap, String, int), which returns the boolean value need or doesn't need a translation.

The newness of any source file in comparison with the produced translated file (result file) can be ascertain with several conditions:

• Timestamp check: The timestamp of the result file is compared with the timestamp of all source files. This is the classic method, used by makers often.
  • Advantage: Fast detection of newness.
  • Disadvantage:
    • If a new file is produced from another tool but without any effective changes, it is detect as newly. Therefore it is regarded in the translation process. If all source files are produced newly in that way, this method is ineffective.
    • If a older file should be taken with other content, it is not recognized as changed (as newly for translation).
• Comparison with stored last file: This may be seems as a expensive method. It allows to compare whether only productive code is changed, in opposite to comments, which are not effective in the translated result. This method should be used if the sources are generated from another tool, which produces new files without real changes but with ineffective-for-translation comments.
  • Advantage: Correct detection of newly sources.
  • Disadvantage: There should be a build-source-bundle at a second position in the file system.
  The comparison of source files with comment-detection need only a few milliseconds per file. It may be some times faster than a translation process.
• Comparison of timestamp and size of the source file with the last used: The timestamp and file size should be noted in a textual list. This text list is used to compare the current values.
  • Advantage:
    • Fast detection of newness.
    • Correct detection if older files are used. This method doesn't works correct only if the size and timestamp is equal but the content is different. That situation can occur only if the files are patched.
  • Disadvantages: In opposite to comparison of files no detection of only comments. The method isn't usefull if the source files are generated by a tool with different informations in comment, which are ineffective for the translation.
• Disadvantage: There should be a build-source-bundle at a second position in the file system.

Dependency detection: Dependencies are included or used files while translation. This algorithm is used for C/C++-Sources. The #include statement is responsible to include.

• If the source is recognized as 'not newly' against the result (C-object file), the dependencies are checked in a file parallel to the object file with localname.dep. It contains the absolute or an relative path to the included files. That files are checked.
• If the sources is recognized as 'not newly', but the dependency file doesn't exists, the source should be analyzed for dependencies. That is done in the file comparison.
• If the newly of the source should be detected by comparison of content, the primary dependencies are detected while that comparison process runs. A dependency-file ins't necessary. But it will be produced for manually visitation.

Include Path and included files: The include path is given in the config file. It is valid for all sources. It is the common include path. An additional include path may be given for specified -src=SRCPATH files with an additional calling argument -srcInclpath=PATH.

The included files are named usual only with its name or with a prefix path, like

   #include "file.h"
   #include "path/file.h"
 

For all included files, which are found in the common include path, an index is filled. In that kind an included file, which was found and processed one time, can be re-found with a short index access and can be detected as 'already processed'. An instance InfoFileDependencies are related to it. Included files, which are not found in the common include path, should be searched in the additional path. Then the absolute path is known and that included files can be found with its absolute path in the same list.