CodeSwitcher.java
/*
* For work developed by the HSQL Development Group:
*
* Copyright (c) 2001-2024, The HSQL Development Group
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the HSQL Development Group nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*
*
* For work originally developed by the Hypersonic SQL Group:
*
* Copyright (c) 1995-2000, The Hypersonic SQL Group.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the Hypersonic SQL Group nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE HYPERSONIC SQL GROUP,
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* on behalf of the Hypersonic SQL Group.
*/
package org.hsqldb.util;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.LineNumberReader;
import java.util.ArrayList;
// fredt@users 20020315 - patch 1.7.0 - minor fixes
// changed line separator to System based value
// moved the Profile class to org.hsqldb.test package
// fredt@users 20021020 - patch 1.7.1 - formatting fix
// avoid moving blank lines which would be interpreted as code change by CVS
// fredt@users 20021118 - patch 1.7.2 - no-change, no-save fix
// if the file contents do not change, do not save a new version of file
// fredt@users 20040322 - removed unused profiling code
// fredt@users 20080315 - added ifndef switch
// fredt@users 20190515 - enhancements
/**
* Modifies the source code to support different JDK or profile settings.
* <pre>
* Usage: java CodeSwitcher paths|{--pathlist=listfile} [{+|-}label...] [+][-]
* If no labels are specified then all used
* labels in the source code are shown.
* Use +MODE to switch on the things labeld MODE
* Use -MODE to switch off the things labeld MODE
* Path: Any number of path or files may be
* specified. Use . for the current directory
* (including sub-directories).
* Example: java CodeSwitcher +JAVA2 .
* This example switches on code labeled JAVA2
* in all *.java files in the current directory
* and all subdirectories.
* java CodeSwitcher + .
* Adds test code to the code.
* java CodeSwitcher - .
* Removes test code from the code
* </pre>
*
* @author Thomas Mueller (Hypersonic SQL Group)
* @version 2.5.0
* @since Hypersonic SQL
*/
public class CodeSwitcher {
private static final String ls = System.getProperty("line.separator", "\n");
private ArrayList<String> vList;
private ArrayList<String> vSwitchOn;
private ArrayList<String> vSwitchOff;
private ArrayList<String> vSwitches;
private static final int MAX_LINELENGTH = 82;
public static void main(String[] a) {
CodeSwitcher s = new CodeSwitcher();
if (a.length == 0) {
showUsage();
return;
}
File listFile = null;
File baseDir = null;
for (int i = 0; i < a.length; i++) {
String p = a[i];
if (p.startsWith("+")) {
s.vSwitchOn.add(p.substring(1));
} else if (p.startsWith("--basedir=")) {
baseDir = new File(p.substring("--basedir=".length()));
} else if (p.startsWith("--pathlist=")) {
listFile = new File(p.substring("--pathlist=".length()));
} else if (p.startsWith("-")) {
s.vSwitchOff.add(p.substring(1));
} else {
s.addDir(p);
}
}
if (baseDir != null) {
if (listFile == null) {
System.err.println(
"--basedir= setting ignored, since only used for list files");
} else {
if (!baseDir.isDirectory()) {
System.err.println(
"Skipping listfile since basedir '"
+ baseDir.getAbsolutePath() + "' is not a directory");
listFile = null;
}
}
}
if (listFile != null) {
try {
BufferedReader br = new BufferedReader(
new FileReader(listFile));
String st, p;
int hashIndex;
File f;
while ((st = br.readLine()) != null) {
hashIndex = st.indexOf('#');
p = ((hashIndex > -1)
? st.substring(0, hashIndex)
: st).trim();
if (p.isEmpty()) {
continue;
}
f = (baseDir == null)
? (new File(p))
: (new File(baseDir, p));
if (f.isFile()) {
s.addDir(f);
} else {
System.err.println(
"Skipping non-file '" + p.trim() + "'");
}
}
} catch (Exception e) {
System.err.println(
"Failed to read pathlist file '"
+ listFile.getAbsolutePath() + "'");
}
}
if (s.size() < 1) {
printError("No path specified, or no specified paths qualify");
showUsage();
}
s.process();
if (s.vSwitchOff.isEmpty() && s.vSwitchOn.isEmpty()) {
s.printSwitches();
}
}
public int size() {
return (vList == null)
? 0
: vList.size();
}
/**
* Method declaration
*
*/
static void showUsage() {
System.out.print(
"Usage: java CodeSwitcher paths|{--pathlist=listfile} "
+ "[{+|-}label...] [+][-]\n"
+ "If no labels are specified then all used\n"
+ "labels in the source code are shown.\n"
+ "Use +MODE to switch on the things labeld MODE\n"
+ "Use -MODE to switch off the things labeld MODE\n"
+ "Path: Any number of path or files may be\n"
+ "specified. Use . for the current directory\n"
+ "(including sub-directories).\n"
+ "Example: java CodeSwitcher +JAVA2 .\n"
+ "This example switches on code labeled JAVA2\n"
+ "in all *.java files in the current directory\n"
+ "and all subdirectories.\n");
}
/**
* Constructor declaration
*
*/
CodeSwitcher() {
vList = new ArrayList<>();
vSwitchOn = new ArrayList<>();
vSwitchOff = new ArrayList<>();
vSwitches = new ArrayList<>();
}
/**
* Method declaration
*
*/
void process() {
int len = vList.size();
for (int i = 0; i < len; i++) {
System.out.print(".");
String file = vList.get(i);
if (!processFile(file)) {
System.out.println("in file " + file + " !");
}
}
System.out.println();
}
/**
* Method declaration
*
*/
void printSwitches() {
System.out.println("Used labels:");
for (int i = 0; i < vSwitches.size(); i++) {
System.out.println(vSwitches.get(i));
}
}
void addDir(String path) {
addDir(new File(path));
}
void addDir(File f) {
if (f.isFile() && f.getName().endsWith(".java")) {
vList.add(f.getPath());
} else if (f.isDirectory()) {
File[] list = f.listFiles();
if (list == null) {
return;
}
for (int i = 0; i < list.length; i++) {
addDir(list[i]);
}
}
}
boolean processFile(String name) {
File f = new File(name);
File fnew = new File(name + ".new");
int state = 0; // 0=normal 1=inside_if 2=inside_else
boolean switchoff = false;
boolean working = false;
try {
ArrayList<String> v = getFileLines(f);
ArrayList<String> v1 = new ArrayList<>(v.size());
for (int i = 0; i < v.size(); i++) {
v1.add(v.get(i));
}
for (int i = 0; i < v.size(); i++) {
String line = v.get(i);
if (line == null) {
break;
}
if (working) {
if (line.equals("/*") || line.equals("*/")) {
v.remove(i--);
continue;
}
}
if (line.startsWith("//#")) {
if (line.startsWith("//#ifdef ")) {
if (state != 0) {
printError(
"'#ifdef' not allowed inside '#ifdef' at line "
+ i);
return false;
}
state = 1;
String s = line.substring(9);
if (vSwitchOn.contains(s)) {
working = true;
switchoff = false;
} else if (vSwitchOff.contains(s)) {
working = true;
v.add(++i, "/*");
switchoff = true;
}
if (!vSwitches.contains(s)) {
vSwitches.add(s);
}
} else if (line.startsWith("//#ifndef ")) {
if (state != 0) {
printError("'#ifndef' not allowed inside '#ifdef'");
return false;
}
state = 1;
String s = line.substring(10);
if (vSwitchOff.contains(s)) {
working = true;
switchoff = false;
} else if (vSwitchOn.contains(s)) {
working = true;
v.add(++i, "/*");
switchoff = true;
}
if (!vSwitches.contains(s)) {
vSwitches.add(s);
}
} else if (line.startsWith("//#else")) {
if (state != 1) {
printError("'#else' without '#ifdef'");
return false;
}
state = 2;
if (!working) {}
else if (switchoff) {
if (v.get(i - 1).isEmpty()) {
v.add(i - 1, "*/");
i++;
} else {
v.add(i++, "*/");
}
switchoff = false;
} else {
v.add(++i, "/*");
switchoff = true;
}
} else if (line.startsWith("//#endif")) {
if (state == 0) {
printError("'#endif' without '#ifdef'");
return false;
}
state = 0;
if (working && switchoff) {
if (v.get(i - 1).isEmpty()) {
v.add(i - 1, "*/");
i++;
} else {
v.add(i++, "*/");
}
}
working = false;
} else {}
}
}
if (state != 0) {
printError("'#endif' missing");
return false;
}
boolean filechanged = false;
for (int i = 0; i < v.size(); i++) {
if (!v1.get(i).equals(v.get(i))) {
filechanged = true;
break;
}
}
if (!filechanged) {
return true;
}
long timestamp = f.lastModified();
writeFileLines(v, fnew);
File fbak = new File(name + ".bak");
fbak.delete();
f.renameTo(fbak);
File fcopy = new File(name);
fnew.renameTo(fcopy);
fcopy.setLastModified(timestamp);
fbak.delete();
return true;
} catch (Exception e) {
printError(e.toString());
return false;
}
}
static ArrayList<String> getFileLines(File f) throws IOException {
LineNumberReader read = new LineNumberReader(new FileReader(f));
ArrayList<String> v = new ArrayList<>();
for (;;) {
String line = read.readLine();
if (line == null) {
break;
}
v.add(line);
}
read.close();
return v;
}
static void writeFileLines(ArrayList v, File f) throws IOException {
FileWriter write = new FileWriter(f);
for (int i = 0; i < v.size(); i++) {
write.write((String) v.get(i));
write.write(ls);
}
write.flush();
write.close();
}
static void printError(String error) {
System.out.println();
System.out.println("ERROR: " + error);
}
}