de.frame4j

Class SVNkeysFilter

java.lang.Object

de.frame4j.util.App

de.frame4j.SVNkeysFilter

All Implemented Interfaces:

AttrSettable, TextHelper.MessageComponents, TextHelper.ReplaceVisitor, AppMBean, ComVar, UIInfo, ActionListener, EventListener

@MinDoc(copyright="Copyright 2018  A. Weinert",
        author="Albrecht Weinert",
        version="V.41",
        lastModified="23.04.2021",
        usage="start as Java application (option -?)\njava de.frame4j.SVNkeysFilter inputFile  \njava de.frame4j.SVNkeysFilter [options]  \nsee de.frame4j.SVNkeysFilter javaDoc for details",
        purpose="refine and beautify a file\'s SVN tags / Doxygen filter")
public class SVNkeysFilter
extends App
implements TextHelper.ReplaceVisitor

Beautify one text files got from Subversion .

This application reads one input (text) file and beautifies / modifies the text contained in Subversion (SVN) keywords (tags). The modified text is put to normal / standard output.

This functionality is a simplification of SVNkeys; see the details there. This (only) one file to standard output simplification fits exactly the specification of a Doxygen filter — and that is the purpose of this programme.

In the text file read some replacements may be done; in the standard setting they are:

• replacing tabs by three spaces
• replacing dollar bracketed $CVSkeyword$ or $CVSkeyword: value$, namely
  • "Date" by "03.11.2009", that is by the actual date or by the date of last file modification in the form defined by "j.m.Y" (see TimeHelper.format(CharSequence, java.time.ZonedDateTime))
  • "Date: utcDate" by the reformatted date relates to local time zone in the form defined by "j.m.Y" (see TimeHelper.format(CharSequence, java.time.ZonedDateTime))
    Remark: CVS and cvsNT use UTC without specifying it while SVN explicitly specifies the zone offset; both works here.
  • "Author" by "A. Weinert"
    Remark: thats changeable, of course, see above and SVNkeys.properties
  • "Author: name" by "name"
  • "Name" by "last revision (HEAD)"
  • "Name: release" by "release"
  • "Revision" by "new"
  • "Revision: revision" by "revision"
  • "Rev" and "LastChangedRevision" are treated like Revision.
  • "LastChangedBy" by "(unknown)"
  • "LastChangedBy: name" by "name"
  • "Id" by "(this file)"
  • "Id: pigsty" by "pigsty"
  • "HeadURL" by "" (nothing)
  • "HeadURL: serverURL" by "serverURL"
  • "Branch" by "" (nothing)
  • "Branch: hare" by "hare"
  • "URL"is treated like HeadURL.

Hint 2: With CVS (and cvsNT) you just have the so called "keyword substitution" always. You have to kill it explicitly sometimes for non text files. With Subversion this nice feature is off by default and must be switched on for every single file, like in example:
svn propset svn:keywords "Date Revision Author Id HeadURL" *.java
Stupidly it's really for the single file(s) not for the file type, as the example might suggest. Bringing in a new .java file you must repeat the procedure for it.

Hint 3: This application is part of the framework Frame4J. Frame4J's building and deploying scripts also use this application before compiling or doing the (javaDoc) documentation. That makes Frame4J "self beautifying" (and involved "self building").
So the text you just see is (also) edited by SVNkeys or SVNkeysFilter.

© Copyright 2018 2021 Albrecht Weinert

Nested Class Summary

Nested classes/interfaces inherited from interface de.frame4j.util.ComVar

ComVar.Impl

Field Summary

Fields

Modifier and Type	Field and Description
String	clBrace Closing brace for keywords.
boolean	dateDefaultToMod For empty $Date$ insert the file's modification date.
boolean	dateDefaultToNow For empty $Date$ insert current time.
String	dateFormat Re-format the date; format String.
protected File	dD The file to act on.
String	fieldLengthMarker Field end marker keywords.
String	filModEnc Encoding of files to be modified.
boolean	ignoreKeyCase Ignore case for keywords.
int	maxBraceDist Maximal distance for keyword braces.
String	opBrace Opening brace for keywords.
boolean	reformatDate Re-format the date.
boolean	removeBraces Remove the keyword braces.
boolean	removeContent Remove the keyword content.
String	setOperator Set operator for keywords.
boolean	tabReplace Replace Tabs by spaces.
int	tabWidth Replace tabs by that number of spaces.

Fields inherited from class de.frame4j.util.App

ano, appBase, appIO, appStartTime, appStartTimeMS, args, argsOrig, bgColor, err, fullClassName, help, icon, log, mainThread, myClass, myFrame, name, out, outMode, packName, prop, retCode, runFlag, shortClassName, title, verbose, verbosity

Fields inherited from interface de.frame4j.util.ComVar

AUTHOR, BLANK_STRING, cons, CONSOL_ENCODING, COPYRIGHT, D, D_NaN, D_NegInf, D_PosInf, EMPTY_INT_A, EMPTY_STRING, FILE_ENCODING, FRW_CLLD, FS, FSS, H, hasCons, HOST_IP, HOST_IPv4, HOST_NAME, INIT_ERROR, JAR_ENCODING, JH, JOB_DONE_OK, JRL, LOG_OUT_ERROR, M, MAIN_THREAD_EXC, NO_BYTES, NO_CLASSES, NO_DOUBLES, NO_OBJECTS, NO_PARS_ERROR, NO_STRINGS, NOT_WINDOWS, ON_PI, ONE_DAY, ONE_HOUR, ONE_LEAP_YEAR, ONE_MINUTE, ONE_SECOND, ONE_WEEK, ONE_YEAR, OS, PROG_NAME, PROG_SHORT, PS, RUNTIME, S, SHY, UD, UL, UL_UR_da, UR

Fields inherited from interface de.frame4j.net.AttrSettable

ILLEGAL_TYPE, ILLEGAL_VALUE, NO_ATTRIBUTE, NO_KNOWN_ATTRIBUTE, NO_VALUE, OK, retVtext

Method Summary

Modifier and Type	Method and Description
protected boolean	allowNoPropertiesFile() No own .property file required.
int	doIt() Working method of SVNkeysFilter.
static void	main(String[] args) Start method of SVNkeys.
boolean	parsePartial() Only only partial start parameter parsing by Prop.
int	visit(File dD) File visitor.
String	visit(String opBr, String cont, String clBr) Calculate the text replacements.

Methods inherited from class de.frame4j.util.App

actionPerformed, clientOrder, condHelpLog, connect, errMeld, errMeld, errorExit, errorExit, errorText, extraPropertiesFile, formMessage, formMessage, formMessage, getAbout, getAboutText, getActTime, getAppLogger, getAppStartTime, getArgs, getAuthor, getCopyright, getDbLogger, getExecTimeMs, getExecTimeMsL, getExecTimeString, getHelp, getHelpText, getIcon, getLanguage, getLogHandler, getMessageComponent, getMessageComponentsLength, getMyFrame, getName, getNameWithVersDate, getOutMode, getProp, getPurpose, getStartTime, getStateString, getTheCloser, getTitle, getUsage, getVerbose, getVerbosity, getVersDate, go, go, go, haveIcon, isDebug, isHelp, isHelpLog, isNormal, isRunFlag, isSilent, isTest, isVerbose, logVerbose, logVerbose, makeStatusTextEnd, makeStatusTextStart, messageFormat, normalExit, performeAction, queueAction, regAsStdMBean, repExc, setAboutText, setAttribute, setAttribute, setAuthor, setBgColor, setCodePages, setCopyright, setHelp, setLogOut2, setName, setOutMode, setOutMode, setPurpose, setTitle, setUsage, setVerbose, setVerbose, setVerbosity, setVerbosity, setVersDate, stop, threeLineEndMsg, toString, twoLineEndMsg, twoLineStartMsg, valueLang, valueLang, wakeMainThread

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.frame4j.net.AttrSettable

retVtext

Field Detail

filModEnc

public String filModEnc

Encoding of files to be modified.

The name of the real/current encoding of the text files to be modified. It must fit and is not changed.

No explicit setting (null) defaults to the platform encoding.

Since:

January 2017

tabReplace

public boolean tabReplace

Replace Tabs by spaces.

default: true

See Also:

tabWidth

tabWidth

public int tabWidth

Replace tabs by that number of spaces.

allowed: 2..12
default: 3

See Also:

tabReplace

opBrace

public String opBrace

Opening brace for keywords.

default: (SVN / Subversion standard) is Dollar $

clBrace

public String clBrace

Closing brace for keywords.

default: (SVN / Subversion standard) is Dollar $

setOperator

public String setOperator

Set operator for keywords.

default: (SVN / Subversion standard) is colon :

maxBraceDist

public int maxBraceDist

Maximal distance for keyword braces.

allowed 24 .. 300
other values: no limit (not recommended)
default = 150 (seems high, but #36;HeadURL: .... #36; can get longer.

fieldLengthMarker

public String fieldLengthMarker

Field end marker keywords.

default: Subversion only uses sharp (#)
set to blank or 0 for no effect

removeBraces

public boolean removeBraces

Remove the keyword braces.

Removing the ugly Dollars plus keyword plus colon (:) is the absolute minimal cosmetic prior to deployment.

default: true

removeContent

public boolean removeContent

Remove the keyword content.

default: false

ignoreKeyCase

public boolean ignoreKeyCase

Ignore case for keywords.

Note: SVN / Subversion and CVS are both case sensitive (Date != date).

default: false = case sensitive keywords

reformatDate

public boolean reformatDate

Re-format the date.

default: true

dateFormat

public String dateFormat

Re-format the date; format String.

default: j.m.Y

The format characters are described at TimeHelper.format(CharSequence, java.time.ZonedDateTime).

dateDefaultToNow

public boolean dateDefaultToNow

For empty $Date$ insert current time.

If true the replacement for an empty date is the current time, of course formatted with dateFormat.

default: false

See Also:

dateDefaultToMod

dateDefaultToMod

public boolean dateDefaultToMod

For empty $Date$ insert the file's modification date.

If true the replacement for an empty date is the file modification date, of course formatted with dateFormat. This setting has priority over dateDefaultToNow.

Hint: Due to a bug Subversion will usually not work on $Date$. It needs $Date: $ or $Date: rhubarb $ including the trailing blank!

default: true

dD

protected File dD

The file to act on.

Method Detail

allowNoPropertiesFile

protected boolean allowNoPropertiesFile()

No own .property file required.

Overrides:

allowNoPropertiesFile in class App

Returns:

true

parsePartial

public boolean parsePartial()

Only only partial start parameter parsing by Prop.

Overrides:

parsePartial in class App

Returns:

true

main

public static void main(String[] args)

Start method of SVNkeys.

An exit code (ERRORLEVEL) 0 signalises a run without trouble.

Problems lead to >0. (< 0 not used for sake of Windows.)

exit code 0: OK.
exit code 1: completely run through, content of file, maybe filtered, output to standard output exit code>1: parameter or other starting problems; nothing done.

Hint: Start with -options or more than one file parameter can lead to message output. For use as Doxygen filter provide the file name as just one start parameter.

Parameters:

args - the application's start parameter

visit

public int visit(File dD)

File visitor.

Procession of all text substitutions on the visited file.

visit

public String visit(String opBr,
                    String cont,
                    String clBr)

Calculate the text replacements.

Implement the visitor pattern; here using TextHelper.fUr(CharSequence, ..., ReplaceVisitor).

Specified by:

visit in interface TextHelper.ReplaceVisitor

Parameters:

opBr - opening brace

cont - content

clBr - closing brace

Returns:

replacement (for all three)

See Also:

TextHelper.ReplaceVisitor

doIt

public int doIt()

Working method of SVNkeysFilter.

Specified by:

doIt in class App

Returns:

the exit code; 0 means OK

See Also:

Prop, App.go(String[]), App.go(String[], String, CharSequence), App.mainThread