org.vishia.checkDeps_C

Class InfoFileDependencies

java.lang.Object

org.vishia.checkDeps_C.InfoFileDependencies

All Implemented Interfaces:

AddDependency_InfoFileDependencies

public class InfoFileDependencies
extends java.lang.Object
implements AddDependency_InfoFileDependencies

Information about one file, source or header, with its dependencies and its influences.

Field Summary

Fields

Modifier and Type	Field and Description
private char	cNewly State of the file: ' ' if it is unchanged, and all included files are unchanged.
(package private) MainCmdLogging_ifc	console
private long	dateFileMirror
(package private) long	dateFileSrc The timestamp of the file (lastModified).
(package private) java.io.File	fileMirror
(package private) java.io.File	fileSrc The existing or non-existing include file.
private static java.text.DateFormat	formatTimestamp Format to produce a human readable timestamp of file.
(package private) java.util.Map<java.lang.String,InfoFileDependencies>	includedAllFiles All included files in this included file and all other included files.
(package private) java.util.Map<java.lang.String,InfoFileDependencies>	includedPrimaryDeps All included files in this file read from the dependency input.
(package private) java.util.Map<java.lang.String,InfoFileDependencies>	includedPrimaryFiles All included files in this included file.
(package private) java.util.Map<java.lang.String,InfoFileDependencies>	includingAllFiles All files which includes this file directly or indirectly.
(package private) java.util.Map<java.lang.String,InfoFileDependencies>	includingPrimaryFiles All files which includes this file directly.
private boolean	isSrc True if it is a file from the source pool.
(package private) java.lang.String	sAbsolutePath
private java.lang.String	sDateNameLine Timestamp and name of the file for .dep file and for some reports.
(package private) java.lang.String	sFilePathIncludeline File path like written in Include line between "path" or < path>.
static java.lang.String	spaces The length of this string determines the maximal processed deepness of nested files.
(package private) long	timestampNewestDependingFiles_
static int	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
InfoFileDependencies(java.lang.String sFilePathIncludeline, java.io.File fileSrc, java.io.File fileMirror, boolean isSrc, MainCmdLogging_ifc console)
InfoFileDependencies(java.lang.String sFileAbs, MainCmdLogging_ifc console)

Method Summary

Modifier and Type	Method and Description
(package private) void	addAllParentDependency(InfoFileDependencies child, ObjectFileDeps objDeps, int nRecursion) Recursive call of adding the dependency.
void	addDependency(InfoFileDependencies child, ObjectFileDeps objDeps) Adds a depending file.
java.lang.String	getDataNameLine()
(package private) long	getDateFile()
boolean	isNewlyItself() Returns true if the file is changed in comparison with a last used file for translation.
boolean	isNewlyOrIncludedNewly() Returns true if the file is changed in comparison with a last used file for translation.
boolean	isSrcFile() Returns true if the file is in the source pool.
void	notifyChangedTimestamp()
void	notifyIncludedNewly(ObjectFileDeps objDeps) The fileMirror is copied from fileSrc, because the fileSrc is changed.
void	notifyNewly(ObjectFileDeps objDeps) The fileMirror is copied from fileSrc, because the fileSrc is changed.
boolean	shouldWriteNewly() Returns true if the file is changed in comparison with a last used file for translation or if the source file has non-relevant changes but it is stored with other timestamp.
java.lang.String	toString()
(package private) static void	writeAllBackDeps(java.lang.String sDepFileName, java.util.Map<java.lang.String,InfoFileDependencies> indexAllDeps) Writes a list with all files which are known with the files, which includes it (backward dependencies).
void	writeDependendingFiles(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.String> indexWrittenDeps, MainCmdLogging_ifc console, int nRecursion) Recursively called method to write the dependencies.
(package private) void	xxx_writeBackDeps(InfoFileDependencies info, InfoFileDependencies parent, java.io.Writer writer)
void	xxx_writeDependenciesOfFile(java.io.File fileDep, MainCmdLogging_ifc console) Write dependencies from the given level to a file, including all included files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

version

public static final int version

Version, history and license.

• 2012-12-25 Hartmut new: Inserted in the Zbnf component because it is an integral part of the Zmake concept for C-compilation.
• 2011-05-00 Hartmut created: It was necessary for C-compilation to check real dependencies in a fast way. The dependency check from a GNU compiler was to slow.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

formatTimestamp

private static java.text.DateFormat formatTimestamp

Format to produce a human readable timestamp of file.

spaces

public static java.lang.String spaces

The length of this string determines the maximal processed deepness of nested files. The length is 2 * deepness.

console

final MainCmdLogging_ifc console

sFilePathIncludeline

final java.lang.String sFilePathIncludeline

File path like written in Include line between "path" or < path>.

fileSrc

final java.io.File fileSrc

The existing or non-existing include file.

sAbsolutePath

final java.lang.String sAbsolutePath

fileMirror

final java.io.File fileMirror

dateFileSrc

final long dateFileSrc

The timestamp of the file (lastModified).

dateFileMirror

private long dateFileMirror

timestampNewestDependingFiles_

long timestampNewestDependingFiles_

cNewly

private char cNewly

State of the file:

• ' ' if it is unchanged, and all included files are unchanged.
• '^' if the timestamp is changed, but the content in comparision with mirror file is unchanged.
• '&' if the file itself is unchanged but an included file is changed. Should recompiled!
• '$' if the file itself is unchanged in content but the timestamp is changed, and an included file is changed. Should recompiled!
• '!' if the file is detected as newly against a comparison with a mirror file or against the timestamp in comparison with the dep-file.
• '?' if the file is not found.

isSrc

private final boolean isSrc

True if it is a file from the source pool.

sDateNameLine

private java.lang.String sDateNameLine

Timestamp and name of the file for .dep file and for some reports. This info is prepared if requested.

includedPrimaryDeps

final java.util.Map<java.lang.String,InfoFileDependencies> includedPrimaryDeps

All included files in this file read from the dependency input.

includedPrimaryFiles

final java.util.Map<java.lang.String,InfoFileDependencies> includedPrimaryFiles

All included files in this included file.

includedAllFiles

final java.util.Map<java.lang.String,InfoFileDependencies> includedAllFiles

All included files in this included file and all other included files.

includingPrimaryFiles

final java.util.Map<java.lang.String,InfoFileDependencies> includingPrimaryFiles

All files which includes this file directly.

includingAllFiles

final java.util.Map<java.lang.String,InfoFileDependencies> includingAllFiles

All files which includes this file directly or indirectly.

Constructor Detail

InfoFileDependencies

public InfoFileDependencies(java.lang.String sFilePathIncludeline,
                            java.io.File fileSrc,
                            java.io.File fileMirror,
                            boolean isSrc,
                            MainCmdLogging_ifc console)

InfoFileDependencies

public InfoFileDependencies(java.lang.String sFileAbs,
                            MainCmdLogging_ifc console)

Method Detail

addAllParentDependency

void addAllParentDependency(InfoFileDependencies child,
                            ObjectFileDeps objDeps,
                            int nRecursion)

Recursive call of adding the dependency. If the child is changed (#isNewly(), this will be notified as newly too. If the child is changed, the parent is changed too because it includes the child.

Parameters:

child - It will be added to this.includingAllFiles.

addDependency

public void addDependency(InfoFileDependencies child,
                          ObjectFileDeps objDeps)

Adds a depending file.

Specified by:

addDependency in interface AddDependency_InfoFileDependencies

See Also:

AddDependency_InfoFileDependencies.addDependency(InfoFileDependencies, ObjectFileDeps)

notifyNewly

public void notifyNewly(ObjectFileDeps objDeps)

The fileMirror is copied from fileSrc, because the fileSrc is changed.

notifyIncludedNewly

public void notifyIncludedNewly(ObjectFileDeps objDeps)

The fileMirror is copied from fileSrc, because the fileSrc is changed.

notifyChangedTimestamp

public void notifyChangedTimestamp()

isNewlyItself

public boolean isNewlyItself()

Returns true if the file is changed in comparison with a last used file for translation.

Returns:

false if the newness is not detected. It is possible that the file is newer however, check timestamp! See getDateFile().

isNewlyOrIncludedNewly

public boolean isNewlyOrIncludedNewly()

Returns true if the file is changed in comparison with a last used file for translation.

Returns:

false if the newness is not detected. It is possible that the file is newer however, check timestamp! See getDateFile().

shouldWriteNewly

public boolean shouldWriteNewly()

Returns true if the file is changed in comparison with a last used file for translation or if the source file has non-relevant changes but it is stored with other timestamp.

isSrcFile

public boolean isSrcFile()

Returns true if the file is in the source pool.

Returns:

false if it isn't in the source pool.

getDateFile

long getDateFile()

getDataNameLine

public java.lang.String getDataNameLine()

xxx_writeDependenciesOfFile

public void xxx_writeDependenciesOfFile(java.io.File fileDep,
                                        MainCmdLogging_ifc console)

Write dependencies from the given level to a file, including all included files.

Parameters:

fileDep - The file will be created. The directory of file will be created if not exists. TODO use for new alldep-file

writeDependendingFiles

public void writeDependendingFiles(java.lang.Appendable writer,
                                   java.util.Map<java.lang.String,java.lang.String> indexWrittenDeps,
                                   MainCmdLogging_ifc console,
                                   int nRecursion)
                            throws java.io.IOException

Recursively called method to write the dependencies.

Parameters:

writer - The writer

indexWrittenDeps - Index of processed header-files, any header is written only one time.

index - The tree of dependencies of this level.

nRecursion - counter, will be checked and used as indent

Throws:

java.io.IOException - file writing.

writeAllBackDeps

static void writeAllBackDeps(java.lang.String sDepFileName,
                             java.util.Map<java.lang.String,InfoFileDependencies> indexAllDeps)

Writes a list with all files which are known with the files, which includes it (backward dependencies).

xxx_writeBackDeps

void xxx_writeBackDeps(InfoFileDependencies info,
                       InfoFileDependencies parent,
                       java.io.Writer writer)
                throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object