astyle/ 40777 0 0 0 12235007664 5403 5 astyle/build/ 40777 0 0 0 12235007664 6502 5 astyle/build/clang/ 40777 0 0 0 12235007664 7566 5 astyle/build/clang/Makefile 100777 0 0 11225 12235007664 11347 0 # Make file for GCC compiler on Linux or compatible OS
# The license.html file describes the conditions under which this software may be distributed.
# list of source files
SRC = astyle_main.cpp \
ASBeautifier.cpp \
ASFormatter.cpp \
ASEnhancer.cpp \
ASLocalizer.cpp \
ASResource.cpp
# source directories
vpath %.cpp ../../src
vpath %.h ../../src
# NOTE for java compiles the environment variable $JAVA_HOME must be set
# example: export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.00
ifndef JAVA_HOME
JAVA_HOME = /usr/lib/jvm/default-java
endif
# set prefix if not defined on the command line
ifndef prefix
prefix=/usr
endif
SYSCONF_PATH=$(prefix)/share/doc/astyle
# the path was changed in release 2.01
# SYSCONF_PATH_OLD may be removed at the appropriate time
SYSCONF_PATH_OLD=$(prefix)/share/astyle
# define macros
bindir = bin
objdir = obj
ipath=$(prefix)/bin
CBASEFLAGS = -W -Wall -fno-rtti -fno-exceptions
JAVAINCS = -I$(JAVA_HOME)/include
CXX = clang++
INSTALL=install -o $(USER) -g $(USER)
##################################################
# define compile options for each build
ifdef CFLAGS
CFLAGSr = -DNDEBUG $(CBASEFLAGS) $(CFLAGS)
CFLAGSd = -g $(CBASEFLAGS) $(CFLAGS)
else
CFLAGSr = -DNDEBUG -O3 $(CBASEFLAGS)
CFLAGSd = -g $(CBASEFLAGS)
endif
CFLAGSs = -DASTYLE_LIB -fpic $(CFLAGSr)
CFLAGSsd = -DASTYLE_LIB -fpic $(CFLAGSd)
CFLAGSa = -DASTYLE_LIB $(CFLAGSr)
CFLAGSad = -DASTYLE_LIB $(CFLAGSd)
CFLAGSsj = -DASTYLE_JNI -fpic $(CFLAGSr) $(JAVAINCS)
CFLAGSsjd = -DASTYLE_JNI -fpic $(CFLAGSd) $(JAVAINCS)
# define link options
ifdef LDFLAGS
LDFLAGSr = $(LDFLAGS)
LDFLAGSd = $(LDFLAGS)
else
LDFLAGSr = -s
LDFLAGSd =
endif
# object files are built from the source list $(SRC)
# a suffix is added for each build
OBJ = $(patsubst %.cpp,$(objdir)/%.o,$(SRC))
OBJd = $(patsubst %.cpp,$(objdir)/%_d.o,$(SRC))
OBJs = $(patsubst %.cpp,$(objdir)/%_s.o,$(SRC))
OBJsd = $(patsubst %.cpp,$(objdir)/%_sd.o,$(SRC))
OBJa = $(patsubst %.cpp,$(objdir)/%_a.o,$(SRC))
OBJad = $(patsubst %.cpp,$(objdir)/%_ad.o,$(SRC))
OBJsj = $(patsubst %.cpp,$(objdir)/%_sj.o,$(SRC))
OBJsjd = $(patsubst %.cpp,$(objdir)/%_sjd.o,$(SRC))
# define object file rule (with the suffix) for each build
# OBJ
$(objdir)/%.o: %.cpp astyle.h astyle_main.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSr) -c -o $@ $<
# OBJd
$(objdir)/%_d.o: %.cpp astyle.h astyle_main.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSd) -c -o $@ $<
# OBJs
$(objdir)/%_s.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSs) -c -o $@ $<
# OBJsd
$(objdir)/%_sd.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSsd) -c -o $@ $<
# OBJa
$(objdir)/%_a.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSa) -c -o $@ $<
# OBJad
$(objdir)/%_ad.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSad) -c -o $@ $<
# OBJsj
$(objdir)/%_sj.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSsj) -c -o $@ $<
# OBJsjd
$(objdir)/%_sjd.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSsjd) -c -o $@ $<
##################################################
# define build dependencies for each command
release: astyle
astyle: $(OBJ)
@ mkdir -p $(bindir)
$(CXX) $(LDFLAGSr) -o $(bindir)/$@ $^
@ echo
debug: astyled
astyled: $(OBJd)
@ mkdir -p $(bindir)
$(CXX) $(LDFLAGSd) -o $(bindir)/$@ $^
@ echo
shared: libastyle.so
libastyle.so: $(OBJs)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSr) -o $(bindir)/$@ $^
@ echo
shareddebug: libastyled.so
libastyled.so: $(OBJsd)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSd) -o $(bindir)/$@ $^
@ echo
static: libastyle.a
libastyle.a: $(OBJa)
@ mkdir -p $(bindir)
ar crs $(bindir)/$@ $^
@ echo
staticdebug: libastyled.a
libastyled.a: $(OBJad)
@ mkdir -p $(bindir)
ar crs $(bindir)/$@ $^
@ echo
java: libastylej.so
libastylej.so: $(OBJsj)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSr) -o $(bindir)/$@ $^
@ echo
javadebug: libastylejd.so
libastylejd.so: $(OBJsjd)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSd) -o $(bindir)/$@ $^
@ echo
all: release debug shared shareddebug static staticdebug
javaall: java javadebug
clean:
rm -f $(objdir)/*.o $(bindir)/*astyle*
cleanobj:
rm -f $(objdir)/*.o
install:
$(INSTALL) -m 755 -d $(ipath)
@$(INSTALL) -m 755 $(bindir)/astyle $(ipath)
$(INSTALL) -m 755 -d $(SYSCONF_PATH)
@mkdir -p $(SYSCONF_PATH)/html;
@for files in ../../doc/*.html ../../doc/*.css; \
do \
$(INSTALL) -m 644 $$files $(SYSCONF_PATH)/html; \
done
@if [ -d $(SYSCONF_PATH_OLD) ]; then \
rm -rf $(SYSCONF_PATH_OLD); \
fi
uninstall:
rm -f $(ipath)/astyle
rm -rf $(SYSCONF_PATH)
@if [ -d $(SYSCONF_PATH_OLD) ]; then \
rm -rf $(SYSCONF_PATH_OLD); \
fi
astyle/build/gcc/ 40777 0 0 0 12235007664 7236 5 astyle/build/gcc/Makefile 100777 0 0 11220 12235007664 11012 0 # Make file for GCC compiler on Linux or compatible OS
# The license.html file describes the conditions under which this software may be distributed.
# list of source files
SRC = astyle_main.cpp \
ASBeautifier.cpp \
ASFormatter.cpp \
ASEnhancer.cpp \
ASLocalizer.cpp \
ASResource.cpp
# source directories
vpath %.cpp ../../src
vpath %.h ../../src
# NOTE for java compiles the environment variable $JAVA_HOME must be set
# example: export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.00
ifndef JAVA_HOME
JAVA_HOME = /usr/lib/jvm/default-java
endif
# set prefix if not defined on the command line
ifndef prefix
prefix=/usr
endif
SYSCONF_PATH=$(prefix)/share/doc/astyle
# the path was changed in release 2.01
# SYSCONF_PATH_OLD may be removed at the appropriate time
SYSCONF_PATH_OLD=$(prefix)/share/astyle
# define macros
bindir = bin
objdir = obj
ipath=$(prefix)/bin
CBASEFLAGS = -W -Wall -fno-rtti -fno-exceptions
JAVAINCS = -I$(JAVA_HOME)/include
CXX = g++
INSTALL=install -o $(USER) -g $(USER)
##################################################
# define compile options for each build
ifdef CFLAGS
CFLAGSr = -DNDEBUG $(CBASEFLAGS) $(CFLAGS)
CFLAGSd = -g $(CBASEFLAGS) $(CFLAGS)
else
CFLAGSr = -DNDEBUG -O3 $(CBASEFLAGS)
CFLAGSd = -g $(CBASEFLAGS)
endif
CFLAGSs = -DASTYLE_LIB -fpic $(CFLAGSr)
CFLAGSsd = -DASTYLE_LIB -fpic $(CFLAGSd)
CFLAGSa = -DASTYLE_LIB $(CFLAGSr)
CFLAGSad = -DASTYLE_LIB $(CFLAGSd)
CFLAGSsj = -DASTYLE_JNI -fpic $(CFLAGSr) $(JAVAINCS)
CFLAGSsjd = -DASTYLE_JNI -fpic $(CFLAGSd) $(JAVAINCS)
# define link options
ifdef LDFLAGS
LDFLAGSr = $(LDFLAGS)
LDFLAGSd = $(LDFLAGS)
else
LDFLAGSr = -s
LDFLAGSd =
endif
# object files are built from the source list $(SRC)
# a suffix is added for each build
OBJ = $(patsubst %.cpp,$(objdir)/%.o,$(SRC))
OBJd = $(patsubst %.cpp,$(objdir)/%_d.o,$(SRC))
OBJs = $(patsubst %.cpp,$(objdir)/%_s.o,$(SRC))
OBJsd = $(patsubst %.cpp,$(objdir)/%_sd.o,$(SRC))
OBJa = $(patsubst %.cpp,$(objdir)/%_a.o,$(SRC))
OBJad = $(patsubst %.cpp,$(objdir)/%_ad.o,$(SRC))
OBJsj = $(patsubst %.cpp,$(objdir)/%_sj.o,$(SRC))
OBJsjd = $(patsubst %.cpp,$(objdir)/%_sjd.o,$(SRC))
# define object file rule (with the suffix) for each build
# OBJ
$(objdir)/%.o: %.cpp astyle.h astyle_main.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSr) -c -o $@ $<
# OBJd
$(objdir)/%_d.o: %.cpp astyle.h astyle_main.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSd) -c -o $@ $<
# OBJs
$(objdir)/%_s.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSs) -c -o $@ $<
# OBJsd
$(objdir)/%_sd.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSsd) -c -o $@ $<
# OBJa
$(objdir)/%_a.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSa) -c -o $@ $<
# OBJad
$(objdir)/%_ad.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSad) -c -o $@ $<
# OBJsj
$(objdir)/%_sj.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSsj) -c -o $@ $<
# OBJsjd
$(objdir)/%_sjd.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSsjd) -c -o $@ $<
##################################################
# define build dependencies for each command
release: astyle
astyle: $(OBJ)
@ mkdir -p $(bindir)
$(CXX) $(LDFLAGSr) -o $(bindir)/$@ $^
@ echo
debug: astyled
astyled: $(OBJd)
@ mkdir -p $(bindir)
$(CXX) $(LDFLAGSd) -o $(bindir)/$@ $^
@ echo
shared: libastyle.so
libastyle.so: $(OBJs)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSr) -o $(bindir)/$@ $^
@ echo
shareddebug: libastyled.so
libastyled.so: $(OBJsd)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSd) -o $(bindir)/$@ $^
@ echo
static: libastyle.a
libastyle.a: $(OBJa)
@ mkdir -p $(bindir)
ar crs $(bindir)/$@ $^
@ echo
staticdebug: libastyled.a
libastyled.a: $(OBJad)
@ mkdir -p $(bindir)
ar crs $(bindir)/$@ $^
@ echo
java: libastylej.so
libastylej.so: $(OBJsj)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSr) -o $(bindir)/$@ $^
@ echo
javadebug: libastylejd.so
libastylejd.so: $(OBJsjd)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSd) -o $(bindir)/$@ $^
@ echo
all: release debug shared shareddebug static staticdebug
javaall: java javadebug
clean:
rm -f $(objdir)/*.o $(bindir)/*astyle*
cleanobj:
rm -f $(objdir)/*.o
install:
$(INSTALL) -m 755 -d $(ipath)
@$(INSTALL) -m 755 $(bindir)/astyle $(ipath)
$(INSTALL) -m 755 -d $(SYSCONF_PATH)
@mkdir -p $(SYSCONF_PATH)/html;
@for files in ../../doc/*.html ../../doc/*.css; \
do \
$(INSTALL) -m 644 $$files $(SYSCONF_PATH)/html; \
done
@if [ -d $(SYSCONF_PATH_OLD) ]; then \
rm -rf $(SYSCONF_PATH_OLD); \
fi
uninstall:
rm -f $(ipath)/astyle
rm -rf $(SYSCONF_PATH)
@if [ -d $(SYSCONF_PATH_OLD) ]; then \
rm -rf $(SYSCONF_PATH_OLD); \
fi
astyle/build/intel/ 40777 0 0 0 12235007664 7615 5 astyle/build/intel/Makefile 100777 0 0 12722 12235007664 11401 0 # Make file for Intel compiler on Linux or compatible OS
# The license.html file describes the conditions under which this software may be distributed.
#
# Before running "make" the COMPILER environment variables must be set.
# To set the environment variables "source" the compiler environment script:
# source /opt/intel/bin/iccvars.sh intel64
# Refer to the install instructions for details.
#
# IF YOU GET AN ERROR MESSAGE:
# *** No rule to make target `obj/astyle_main.o', needed by `astyle'.
# SEE THE ABOVE INSTRUCTIONS.
# list of source files
SRC = astyle_main.cpp \
ASBeautifier.cpp \
ASFormatter.cpp \
ASEnhancer.cpp \
ASLocalizer.cpp \
ASResource.cpp
# source directories
vpath %.cpp ../../src
vpath %.h ../../src
# NOTE for java compiles the environment variable $JAVA_HOME must be set
# example: export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.00
ifndef JAVA_HOME
JAVA_HOME = /usr/lib/jvm/default-java
endif
# set prefix if not defined on the command line
ifndef prefix
prefix=/usr
endif
SYSCONF_PATH=$(prefix)/share/doc/astyle
# the path was changed in release 2.01
# SYSCONF_PATH_OLD may be removed at the appropriate time
SYSCONF_PATH_OLD=$(prefix)/share/astyle
# define macros
bindir = bin
objdir = obj
ipath=$(prefix)/bin
# if the intel compiler version doesn't support the current GCC headers use -gxx-name=g++-4.x where x is a previous GCC compiler
# the following were REMOVED in release 2011.1.107
# -vec-report0 turns off BLOCK WAS VECTORIZED warnings. To disable vectorization use -mia32 instead.
# -no-multibyte-chars is a temporary compiler bug work-around, http://software.intel.com/en-us/forums/intel-c-compiler/topic/56258
CBASEFLAGS = -w2 -Wall -fno-rtti -fno-exceptions
JAVAINCS = -I$(JAVA_HOME)/include
CXX = icpc
INSTALL=install -o $(USER) -g $(USER)
##################################################
# define compile options for each build
ifdef CFLAGS
CFLAGSr = -DNDEBUG $(CBASEFLAGS) $(CFLAGS)
CFLAGSd = -g $(CBASEFLAGS) $(CFLAGS)
else
CFLAGSr = -DNDEBUG -O3 $(CBASEFLAGS)
CFLAGSd = -g $(CBASEFLAGS)
endif
CFLAGSs = -DASTYLE_LIB -fpic $(CFLAGSr)
CFLAGSsd = -DASTYLE_LIB -fpic $(CFLAGSd)
CFLAGSa = -DASTYLE_LIB $(CFLAGSr)
CFLAGSad = -DASTYLE_LIB $(CFLAGSd)
CFLAGSsj = -DASTYLE_JNI -fpic $(CFLAGSr) $(JAVAINCS)
CFLAGSsjd = -DASTYLE_JNI -fpic $(CFLAGSd) $(JAVAINCS)
# define link options
ifdef LDFLAGS
LDFLAGSr = $(LDFLAGS)
LDFLAGSd = $(LDFLAGS)
else
LDFLAGSr = -s -static-intel
LDFLAGSd = -static-intel
endif
# object files are built from the source list $(SRC)
# a suffix is added for each build
OBJ = $(patsubst %.cpp,$(objdir)/%.o,$(SRC))
OBJd = $(patsubst %.cpp,$(objdir)/%_d.o,$(SRC))
OBJs = $(patsubst %.cpp,$(objdir)/%_s.o,$(SRC))
OBJsd = $(patsubst %.cpp,$(objdir)/%_sd.o,$(SRC))
OBJa = $(patsubst %.cpp,$(objdir)/%_a.o,$(SRC))
OBJad = $(patsubst %.cpp,$(objdir)/%_ad.o,$(SRC))
OBJsj = $(patsubst %.cpp,$(objdir)/%_sj.o,$(SRC))
OBJsjd = $(patsubst %.cpp,$(objdir)/%_sjd.o,$(SRC))
# define object file rule (with the suffix) for each build
# OBJ
$(objdir)/%.o: %.cpp astyle.h astyle_main.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSr) -c -o $@ $<
# OBJd
$(objdir)/%_d.o: %.cpp astyle.h astyle_main.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSd) -c -o $@ $<
# OBJs
$(objdir)/%_s.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSs) -c -o $@ $<
# OBJsd
$(objdir)/%_sd.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSsd) -c -o $@ $<
# OBJa
$(objdir)/%_a.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSa) -c -o $@ $<
# OBJad
$(objdir)/%_ad.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSad) -c -o $@ $<
# OBJsj
$(objdir)/%_sj.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSsj) -c -o $@ $<
# OBJsjd
$(objdir)/%_sjd.o: %.cpp astyle.h
@ mkdir -p $(objdir)
$(CXX) $(CFLAGSsjd) -c -o $@ $<
##################################################
# define build dependencies for each command
release: astyle
astyle: $(OBJ)
@ mkdir -p $(bindir)
$(CXX) $(LDFLAGSr) -o $(bindir)/$@ $^
@ echo
debug: astyled
astyled: $(OBJd)
@ mkdir -p $(bindir)
$(CXX) $(LDFLAGSd) -o $(bindir)/$@ $^
@ echo
shared: libastyle.so
libastyle.so: $(OBJs)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSr) -o $(bindir)/$@ $^
@ echo
shareddebug: libastyled.so
libastyled.so: $(OBJsd)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSd) -o $(bindir)/$@ $^
@ echo
static: libastyle.a
libastyle.a: $(OBJa)
@ mkdir -p $(bindir)
ar crs $(bindir)/$@ $^
@ echo
staticdebug: libastyled.a
libastyled.a: $(OBJad)
@ mkdir -p $(bindir)
ar crs $(bindir)/$@ $^
@ echo
java: libastylej.so
libastylej.so: $(OBJsj)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSr) -o $(bindir)/$@ $^
@ echo
javadebug: libastylejd.so
libastylejd.so: $(OBJsjd)
@ mkdir -p $(bindir)
$(CXX) -shared $(LDFLAGSd) -o $(bindir)/$@ $^
@ echo
all: release debug shared shareddebug static staticdebug
javaall: java javadebug
clean:
rm -f $(objdir)/*.o $(bindir)/*astyle*
cleanobj:
rm -f $(objdir)/*.o
install:
$(INSTALL) -m 755 -d $(ipath)
@$(INSTALL) -m 755 $(bindir)/astyle $(ipath)
$(INSTALL) -m 755 -d $(SYSCONF_PATH)
@mkdir -p $(SYSCONF_PATH)/html;
@for files in ../../doc/*.html ../../doc/*.css; \
do \
$(INSTALL) -m 644 $$files $(SYSCONF_PATH)/html; \
done
@if [ -d $(SYSCONF_PATH_OLD) ]; then \
rm -rf $(SYSCONF_PATH_OLD); \
fi
uninstall:
rm -f $(ipath)/astyle
rm -rf $(SYSCONF_PATH)
@if [ -d $(SYSCONF_PATH_OLD) ]; then \
rm -rf $(SYSCONF_PATH_OLD); \
fi
astyle/doc/ 40777 0 0 0 12235007664 6150 5 astyle/doc/astyle.html 100777 0 0 243523 12235007664 10510 0
Artistic Style
Artistic Style 2.04
A Free, Fast and Small Automatic Formatter
for C, C++, C++/CLI, C#, and Java Source Code
Contents
General Information
Quick Start
Usage
Options
Options File
Bracket Style Options
default bracket style
style=allman
style=java
style=kr
style=stroustrup
style=whitesmith
style=banner
style=gnu
style=linux
style=horstmann
style=1tbs
style=google
style=pico
style=lisp
Tab Options
default indent
indent=spaces
indent=tab
indent=force‑tab
--indent=force‑tab‑x
Bracket Modify Options
attach‑namespaces
attach‑classes
attach‑inlines
attach‑extern‑c
Indentation Options
indent‑classes
indent‑modifiers
indent‑switches
indent‑cases
indent‑namespaces
indent‑labels
indent‑preproc‑define
indent‑preproc‑cond
indent‑col1‑comments
min‑conditional‑indent
max‑instatement‑indent
Padding Options
break‑blocks
break‑blocks=all
pad‑oper
pad‑paren
pad‑paren‑out
pad‑first‑paren‑out
pad‑paren‑in
pad‑header
unpad‑paren
delete‑empty‑lines
fill‑empty‑lines
align‑pointer
align‑reference
Formatting Options
break‑closing‑brackets
break‑elseifs
add‑brackets
add‑one‑line‑brackets
remove‑brackets
keep‑one‑line‑blocks
keep‑one‑line‑statements
convert‑tabs
close‑templates
remove‑comment‑prefix
max‑code‑length
break‑after‑logical
mode
Objective‑C Options
align‑method‑colon
pad‑method‑prefix
unpad‑method‑prefix
pad‑method‑colon
Other Options
suffix suffix=none
recursive
exclude
ignore‑exclude‑errors
ignore‑exclude‑errors‑x
errors‑to‑stdout
preserve‑date
verbose
formatted
quiet
lineend
Command Line Only
options
options=none
ascii
version
help
Line Endings
Line endings in the formatted file will be the same as the input file. If there are mixed line endings the most
frequent occurrence will be used. There is also an option to specify or change the line endings.
File Type
Artistic Style will determine the file type from the file extension. The extension ".java" indicates a Java file,
and ".cs" indicates a C# file. Everything else is a C type file (C, C++, C++/CLI, or Objective-C). If you are
using a non-standard file extension for Java or C#, use one of the --mode=
options.
Wildcards and Recursion
Artistic Style can process directories recursively. Wildcards (such as "*.cpp" or "*.c??") are processed internally.
If a shell is used it should pass the wildcards to Artistic Style instead of resolving them first. For Linux use
double quotes around paths whose filename contains wildcards. For Windows use double quotes around paths whose
filename contains spaces. The "Other Options" section contains information on recursive processing.
File Names
When a file is formatted, the newly indented file retains the original file name. A copy of the original file
is created with an .orig
appended to the original file name. (This can be set to
a different string by the option --suffix=
, or suppressed altogether by the options -n
or --suffix=none
). Thus, after indenting SourceFile.cpp
the indented file will
be named SourceFile.cpp
, while the original pre-indented file will be renamed to SourceFile.cpp.orig
.
Internationalization
Artistic Style has been internationalized to process files and directories in any language.
It has also been translated into several languages. The translation to use is determined from the User Locale
for Windows and the LANG environment variable for other systems. The translation will be done automatically from
these settings. If no translation is available it will default to English. There is an ascii option to use English
instead of the system language.
The source code for the translations is at the end of ASLocalizer.cpp in the form of an English‑Translation
pair. If you make corrections to a translation, send the source as a bug report and it will be included in the
next release.
To add a new language, add a new translation class to ASLocalizer.h. Add the English‑Translation pair to
the constructor in ASLocalizer.cpp. Update the WinLangCode array and add the language code to the function setTranslationClass().
The ASLocalizer.cpp program contains comments that give web pages for obtaining the LCIDs and language codes.
Send the source code as a bug report and it will be included in the next release.
Other Considerations
Artistic Style can format standard class library statements such as Open GL, wxWidgets, Qt, and MFC.
Embedded assembler language is formatted correctly. This includes extended assembly and Microsoft specific assembler
lines and blocks.
Artistic Style can format embedded SQL statements. The SQL formatting will be maintained as long as the standard
hanging indent format is used. If the "exec sql" statement is indented more than the following statements, the
SQL will be aligned in a single column.
Unicode files encoded as UTF‑16, both big and little endian, will be formatted. The files must begin with
a byte order mark (BOM) to be recognized. Files encoded as UTF‑32 will be rejected. Some compilers do not
support these encodings. These files can be converted to UTF‑8 encoding with the program "iconv". There
are Linux and Windows versions available (the Windows version does not seem to work for all encodings). A sample
command line is "iconv ‑f UTF‑16 ‑t UTF‑8 < filein.cpp > fileout.cpp. Visual
Studio can convert the files from the "File > Advanced Save Options" menu. Then select encoding "Unicode (UTF‑8
with signature) - Codepage 65001". There are other development environments and text editors, such as SciTE, that
can convert files to UTF‑8.
Embedded statements that are multiple-line and are NOT in a C type format, such as Python, are usually mal-formatted.
(A C type format has blocks enclosed by brackets and statements terminated by a semi-colon). Macros that define
functions may cause the following code to be mal-formatted because the macro is missing the brackets and semi-colons
from the definition. If you have source code with these types of statements, exclude them with the --exclude=
statement described in the "Other Options" section.
Quick Start
If you have never used Artistic Style there are a couple of ways to start.
One is to run it with no options at all. This will format the file with 4 spaces per indent and will format the
brackets using the default bracket style. The opening brackets will not be changed and the closing brackets will
be broken from the preceding line. The default option will break the brackets for one line blocks and will break
one line statements. To change this you may want to use the option keep-one-line-blocks and/or keep-one-line-statements.
Another way is to use one of the bracket styles described in the "Bracket Style Options" section. Select one with
a bracket formatting style you like. If no indentation option is set, the default option of 4 spaces will be used.
These options also break one line blocks and one line statements as described
above.
Once you are familiar with the options you can customize the format to your personal preference.
Usage
Artistic style is a console program that receives information from the command line. The format of the command
line is:
astyle [options] SourceFile1 SourceFile2 SourceFile3 [ . . . ]
The block parens [ ] indicate that more than one option or more than one filename can be entered. They are NOT
actually included in the command. For the options format see the following Options section.
Example to format a single file:
astyle --style=allman /home/user/project/foo.cpp
Example to format all .cpp and .h files recursively:
astyle --style=allman --recursive /home/user/project/*.cpp /home/user/project/*.h
Another option will format a single file and change the name:
astyle [options] < OriginalSourceFile > BeautifiedSourceFile
The < and > characters are used
to redirect the files into standard input (cin) and out of standard output (cout) - don't forget them! With this
option only one file at a time can be formatted. Wildcards are not recognized, there are no console messages,
and a backup is not created. On Windows the output will always have Windows line ends.
Options
Not specifying any option will result in 4 spaces per indent, no change in bracket placement, and no formatting
changes.
Options may be written in two different ways.
Long options
These options start with '-- ', and must be written one at a time.
(Example: '--style=allman --indent=spaces=4
')
Short Options
These options start with a single '- ', and may be concatenated together.
(Example: '-bps4
' is the same as writing '-b -p -s4
'.)
Options File
An OPTIONAL default options file may be used to supplement or replace the command line options.
The command line options have precedence. If there is a conflict between a command line option and an option in
the default options file, the command line option will be used.
Artistic Style looks for this file in the following locations (in order):
the file indicated by the --options= command line option;
the file and directory indicated by the environment variable ARTISTIC_STYLE_OPTIONS (if it exists);
the file named .astylerc in the directory pointed to by the HOME environment variable (e.g. "$HOME/.astylerc"
on Linux);
the file named astylerc in the directory pointed to by the USERPROFILE environment variable (e.g. "%USERPROFILE%\astylerc"
on Windows).
This option file lookup can be disabled by specifying --options=none on the command line.
Options may be set apart by new-lines, tabs, commas, or spaces.
Long options in the options file may be written without the preceding '--'.
Lines within the options file that begin with '#' are considered line-comments.
Example of a default options file:
--style=allman
indent-switches
-t -p
-M60Ucv
Bracket Style Options
Bracket Style options define the bracket style to use. By default, none of the styles indent namespaces or class
blocks. All options default to 4 spaces per indent, indented with spaces.
default bracket style
If no bracket style option is set, the opening brackets will not be changed and closing brackets will be broken
from the preceding line. See the preceding "Quick Start" section for more information.
--style=allman / --style=ansi / --style=bsd / --style=break / -A1
Allman style formatting/indenting uses broken brackets.
int Foo(bool isBar)
{
if (isBar)
{
bar();
return 1;
}
else
return 0;
}
--style=java / --style=attach / -A2
Java style formatting/indenting uses attached brackets.
int Foo(bool isBar) {
if (isBar) {
bar();
return 1;
} else
return 0;
}
--style=kr / --style=k&r / --style=k/r / -A3
Kernighan & Ritchie style formatting/indenting uses linux brackets. Opening brackets are broken from namespaces,
classes, and function definitions. Brackets are attached to everything else including statements within a function,
arrays, structs, and enums.
Using the k&r option may cause problems because of the &. This can be resolved by enclosing the k&r
in quotes (e.g. ‑‑style="k&r") or by using one of the alternates ‑‑style=kr or ‑‑style=k/r.
int Foo(bool isBar)
{
if (isBar) {
bar();
return 1;
} else
return 0;
}
--style=stroustrup / -A4
Stroustrup style formatting/indenting uses stroustrup brackets. Brackets are broken from function definitions
only. Brackets are attached to everything else including namespaces, classes, and statements within a function, arrays,
structs, and enums. This style frequently is used with an indent of 5 spaces.
int Foo(bool isBar)
{
if (isBar) {
bar();
return 1;
} else
return 0;
}
--style=whitesmith / -A5
Whitesmith style formatting/indenting uses broken, indented brackets. Class blocks and switch blocks are indented
to prevent a 'hanging indent' with switch statements and C++ class modifiers (public, private, protected).
int Foo(bool isBar)
{
if (isBar)
{
bar();
return 1;
}
else
return 0;
}
--style=banner / -A6
Banner style formatting/indenting uses attached, indented brackets. Class blocks and switch blocks are indented
to prevent a 'hanging indent' with switch statements and C++ class modifiers (public, private, protected).
int Foo(bool isBar) {
if (isBar) {
bar();
return 1;
}
else
return 0;
}
--style=gnu / -A7
GNU style formatting/indenting uses broken brackets and indented blocks. This style frequently is used with
an indent of 2 spaces.
Extra indentation is added to blocks within a function . The opening bracket for namespaces, classes,
and functions is not indented.
int Foo(bool isBar)
{
if (isBar)
{
bar();
return 1;
}
else
return 0;
}
--style=linux / --style=knf / -A8
Linux style formatting/indenting uses linux brackets. Opening brackets are broken from namespace, class, and function
definitions. Brackets are attached to everything else including, statements within a function, arrays, structs,
and enums. Minimum conditional indent is one-half indent. If you want a different minimum conditional
indent use the K&R style instead. This style works best with a large indent. It frequently is used with an
indent of 8 spaces.
Also known as Kernel Normal Form (KNF) style, this is the style used in the Linux kernel.
int Foo(bool isBar)
{
if (isFoo) {
bar();
return 1;
} else
return 0;
}
--style=horstmann / -A9
Horstmann style formatting/indenting uses run-in brackets. Brackets are broken and allow run-in statements.
Switches are indented to allow a run-in to the opening switch block. This style frequently is used with an indent
of 3 spaces.
int Foo(bool isBar)
{ if (isBar)
{ bar();
return 1;
} else
return 0;
}
--style=1tbs / --style=otbs / -A10
"One True Brace Style" formatting/indenting uses linux brackets and adds brackets to unbracketed one line conditional
statements. Opening brackets are broken from namespaces, classes, and function definitions. Brackets are attached
to everything else including statements within a function, arrays, structs, and enums.
In the following example brackets have been added to the "return 0;
" statement. The option
‑‑add‑one‑line‑brackets can also be used with this style.
int Foo(bool isBar)
{
if (isFoo) {
bar();
return 1;
} else {
return 0;
}
}
--style=google / -A14
Google style formatting/indenting uses attached brackets and indented class access modifiers. See the indent-modifiers
option for an example of the indented modifiers format. This style frequently is used with an indent of 2 spaces.
int Foo(bool isBar) {
if (isBar) {
bar();
return 1;
} else
return 0;
}
--style=pico / -A11
Pico style formatting/indenting uses run-in brackets and attached closing brackets. Opening brackets are broken
and allow run-in statements. The closing bracket is attached to the last line in the block. Switches are indented
to allow a run-in to the opening switch block. The style implies keep-one-line-blocks and keep-one-line-statements.
If add-brackets is used they will be added as one-line brackets. This style frequently is used with an indent
of 2 spaces.
int Foo(bool isBar)
{ if (isBar)
{ bar();
return 1; }
else
return 0; }
--style=lisp / --style=python / -A12
Lisp style formatting/indenting uses attached opening and closing brackets. Opening brackets are attached at the
end of the statement. The closing bracket is attached to the last line in the block. The style implies keep-one-line-statements
but NOT keep-one-line-blocks. This style does not support one-line brackets. If add-one-line-brackets is used
they will be added as multiple-line brackets.
int Foo(bool isBar) {
if (isBar) {
bar()
return 1; }
else
return 0; }
Tab Options
The following examples show whitespace characters. A space is indicated with a . (dot), a tab
is indicated by a > (greater than).
default indent
If no indentation option is set, the default option of 4 spaces will be used (e.g. -s4
--indent=spaces=4
).
with default values:
void Foo() {
....if (isBar1
............&& isBar2)
........bar();
}
--indent=spaces / --indent=spaces=# / -s#
Indent using # spaces per indent (e.g. -s3
--indent=spaces=3
). # must be between 2 and 20. Not specifying # will result in a default of
4 spaces per indent.
with indent=spaces=3
void Foo() {
...if (isBar1
.........&& isBar2)
......bar();
}
--indent=tab / --indent=tab=# / -t / -t#
Indent using tabs for indentation, and spaces for continuation line alignment . This ensures that
the code is displayed correctly regardless of the viewer’s tab size. Treat each indent as # spaces
(e.g. -t6
/ --indent=tab=6
).
# must be between 2 and 20. If no # is set, treats indents as 4 spaces.
with indent=tab:
void Foo() {
> if (isBar1
> ........&& isBar2)
> > bar();
}
with style=linux, indent=tab=8:
void Foo()
{
> if (isBar1
> ....&& isBar2)
> > bar();
}
--indent=force-tab / --indent=force-tab=# / -T / -T#
Indent using all tab characters, if possible. If a continuation line is not an even number of
tabs, spaces will be added at the end. Treat each tab as # spaces (e.g. -T6
/ --indent=force- tab=6
). # must be between
2 and 20. If no # is set, treats tabs as 4 spaces.
with indent=force-tab:
void Foo() {
> if (isBar1
> > > && isBar2)
> > bar();
}
--indent=force-tab-x / --indent=force-tab-x=# / -xT / -xT#
This force-tab option allows the tab length to be set to a length that is different than the indent length. This
may cause the indentation to be a mix of both tabs and spaces. Tabs will be used to indent, if
possible. If a tab indent cannot be used, spaces will be used instead.
This option sets the tab length. Treat each tab as # spaces (e.g. -xT6
/ --indent=force- tab-x=6
). # must be between
2 and 20. If no # is set, treats tabs as 8 spaces. To change the indent length from the default
of 4 spaces the option "indent=force-tab" must also be used.
with indent=force-tab-x (default tab length of 8 and default indent length of 4):
void Foo() {
....if (isBar1
> ....&& isBar2)
> bar();
}
Bracket Modify Options
--attach-namespaces / -xn
Attach brackets to a namespace statement. This is done regardless of the bracket style being used.
the bracket is always attached to a namespace statement:
namespace FooName {
...
}
--attach-classes / -xc
Attach brackets to a class statement. This is done regardless of the bracket style being used.
the bracket is always attached to a class statement:
class FooClass {
...
} ;
--attach-inlines / -xl
Attach brackets to class and struct inline function definitions. This is not done for run-in type brackets (Horstmann
and Pico styles). This option is effective for C++ files only.
all brackets are always attached to class and struct inline function definitions:
class FooClass
{
void Foo() {
...
}
} ;
--attach-extern-c / -xk
Attach brackets to a bracketed extern "C" statement. This is done regardless of the bracket style being used.
This option is effective for C++ files only.
An extern "C" statement that is part of a function definition is formatted according to the requested bracket
style. Bracketed extern "C" statements are unaffected by the bracket style and this option is the only way to
change them.
this option attaches brackets to a bracketed extern "C" statement:
#ifdef __cplusplus
extern "C" {
#endif
but function definitions are formatted according to the requested bracket style:
extern "C" EXPORT void STDCALL Foo()
{}
Indentation Options
--indent-classes / -C
Indent 'class
' and 'struct
' blocks so that the entire block is indented. The struct
blocks are indented only if an access modifier, 'public:
', 'protected:
' or 'private:
',
is declared somewhere in the struct. This option is effective for C++ files only.
class Foo
{
public:
Foo();
virtual ~Foo();
} ;
becomes:
class Foo
{
public:
Foo();
virtual ~Foo();
} ;
--indent-modifiers / -xG
Indent 'class
' and 'struct
' access modifiers, 'public:
', 'protected:
'
and 'private:
', one half indent. The rest of the class is not indented. This option is effective for
C++ files only. If used with indent‑classes this option will be ignored.
class Foo
{
public:
Foo();
virtual ~Foo();
} ;
becomes:
class Foo
{
public:
Foo();
virtual ~Foo();
} ;
--indent-switches / -S
Indent 'switch
' blocks so that the 'case X:
' statements are indented in the switch
block. The entire case block is indented.
switch (foo)
{
case 1:
a += 1;
break;
case 2:
{
a += 2;
break;
}
}
becomes:
switch (foo)
{
case 1:
a += 1;
break;
case 2:
{
a += 2;
break;
}
}
--indent-cases / -K
Indent 'case X:
' blocks from the 'case X:
' headers. Case statements not enclosed in
blocks are NOT indented.
switch (foo)
{
case 1:
a += 1;
break;
case 2:
{
a += 2;
break;
}
}
becomes:
switch (foo)
{
case 1:
a += 1;
break;
case 2:
{
a += 2;
break;
}
}
--indent-namespaces / -N
Add extra indentation to namespace blocks. This option has no effect on Java files.
namespace foospace
{
class Foo
{
public:
Foo();
virtual ~Foo();
} ;
}
becomes:
namespace foospace
{
class Foo
{
public:
Foo();
virtual ~Foo();
} ;
}
--indent-labels / -L
Add extra indentation to labels so they appear 1 indent less than the current indentation, rather than being flushed
to the left (the default).
void Foo() {
while (isFoo) {
if (isFoo)
goto error;
...
error:
...
}
}
becomes (with indented 'error:'):
void Foo() {
while (isFoo) {
if (isFoo)
goto error;
...
error:
...
}
}
--indent-preproc-define / -w
--indent-preprocessor
has been depreciated and will be removed in a future release.
Indent multi-line preprocessor definitions ending with a backslash. Should be used with --convert-tabs for proper
results. Does a pretty good job, but cannot perform miracles in obfuscated preprocessor definitions. Without this
option the preprocessor statements remain unchanged.
#define Is_Bar(arg,a,b) \
(Is_Foo((arg), (a)) \
|| Is_Foo((arg), (b)))
becomes:
#define Is_Bar(arg,a,b) \
(Is_Foo((arg), (a)) \
|| Is_Foo((arg), (b)))
--indent-preproc-cond / -xw
Indent preprocessor conditional statements to the same level as the source code.
isFoo = true;
#ifdef UNICODE
text = wideBuff;
#else
text = buff;
#endif
becomes:
isFoo = true;
#ifdef UNICODE
text = wideBuff;
#else
text = buff;
#endif
void Foo()\n"
{
if (isFoo)
bar();
}
becomes:
void Foo()\n"
{
if (isFoo)
bar();
}
--min-conditional-indent=# / -m#
Set the minimal indent that is added when a header is built of multiple lines. This indent helps to easily separate
the header from the command statements that follow. The value for #
indicates a number of indents and is a minimum value. The indent may be greater to align with
the data on the previous line.
The valid values are:
0 - no minimal indent. The lines will be aligned with the paren on the preceding line.
1 - indent at least one additional indent.
2 - indent at least two additional indents.
3 - indent at least one-half an additional indent. This is intended for large indents (e.g. 8).
The default value is 2 , two additional indents.
if (a < b
|| c > d)
foo++;
if (a < b
|| c > d)
{
foo++;
}
becomes (when setting --min-conditional-indent=0
):
if (a < b
|| c > d)
foo++;
if (a < b
|| c > d)
{
foo++;
}
--max-instatement-indent=# / -M#
Set the maximum of # spaces to indent a continuation line. The
# indicates a number of columns and must not be greater than 120 .
If no # is set, the default value of 40 will be
used. A maximum of less than two indent lengths will be ignored. This option will prevent continuation lines from
extending too far to the right. Setting a larger value will allow the code to be extended further to the right.
fooArray[] = { red,
green,
blue } ;
fooFunction(barArg1,
barArg2,
barArg3);
becomes (with larger value):
fooArray[] = { red,
green,
blue } ;
fooFunction(barArg1,
barArg2,
barArg3);
Padding Options
--break-blocks / -f
Pad empty lines around header blocks (e.g. 'if
', 'for
', 'while
'...).
isFoo = true;
if (isFoo) {
bar();
} else {
anotherBar();
}
isBar = false;
becomes:
isFoo = true;
if (isFoo) {
bar();
} else {
anotherBar();
}
isBar = false;
--break-blocks=all / -F
Pad empty lines around header blocks (e.g. 'if
', 'for
', 'while
'...). Treat
closing header blocks (e.g. 'else
', 'catch
') as stand-alone blocks.
isFoo = true;
if (isFoo) {
bar();
} else {
anotherBar();
}
isBar = false;
becomes:
isFoo = true;
if (isFoo) {
bar();
} else {
anotherBar();
}
isBar = false;
--pad-oper / -p
Insert space padding around operators. Any end of line comments will remain in the original column, if possible.
Note that there is no option to unpad. Once padded, they stay padded.
if (foo==2)
a=bar((b-c)*a,d--);
becomes:
if (foo == 2)
a = bar((b - c) * a, d--);
--pad-paren / -P
Insert space padding around parenthesis on both the outside and the inside .
Any end of line comments will remain in the original column, if possible.
if (isFoo((a+2), b))
bar(a, b);
becomes:
if ( isFoo ( ( a+2 ), b ) )
bar ( a, b );
--pad-paren-out / -d
Insert space padding around parenthesis on the outside only. Parentheses that are empty will
not be padded. Any end of line comments will remain in the original column, if possible. This can be used with
unpad-paren below to remove unwanted spaces.
if (isFoo((a+2), b))
bar(a, b);
becomes:
if (isFoo ( (a+2), b) )
bar (a, b);
--pad-first-paren-out / -xd
Insert space padding around the first parenthesis in a series on the outside
only. Parentheses that are empty will not be padded. Any end of line comments will remain in the original column,
if possible. This can be used with unpad-paren below to remove unwanted spaces. If used with pad‑paren or
pad‑paren‑out, this option will be ignored. If used with pad‑paren‑in, the result will
be the same as pad‑paren.
if (isFoo((a+2), b))
bar(a, b);
becomes:
if (isFoo ((a+2), b))
bar (a, b);
--pad-paren-in / -D
Insert space padding around parenthesis on the inside only. Any end of line comments will remain
in the original column, if possible. This can be used with unpad-paren below to remove unwanted spaces.
if (isFoo((a+2), b))
bar(a, b);
becomes:
if ( isFoo( ( a+2 ), b ) )
bar( a, b );
if(isFoo((a+2), b))
bar(a, b);
becomes:
if (isFoo((a+2), b))
bar(a, b);
--unpad-paren / -U
Remove extra space padding around parenthesis on the inside and outside. Any end of line comments will remain
in the original column, if possible. This option can be used in combination with the paren padding options pad‑paren
,
pad‑paren‑out
, pad‑paren‑in
, and pad‑header
above. Only padding that has not been requested by other options will be removed.
For example, if a source has parens padded on both the inside and outside, and you want inside only. You need
to use unpad-paren
to remove the outside padding, and pad‑paren‑in
to retain
the inside padding. Using only pad‑paren‑in
would not remove the outside padding.
if ( isFoo( ( a+2 ), b ) )
bar ( a, b );
becomes (with no padding option requested):
if(isFoo((a+2), b))
bar(a, b);
--delete-empty-lines / -xe
Delete empty lines within a function or method. Empty lines outside of functions or methods are NOT deleted. If
used with break-blocks or break-blocks=all it will delete all lines EXCEPT the lines added by the break-blocks
options.
void Foo()
{
foo1 = 1;
foo2 = 2;
}
becomes:
void Foo()
{
foo1 = 1;
foo2 = 2;
}
--fill-empty-lines / -E
Fill empty lines with the white space of the previous line.
--align-pointer=type / -k1
--align-pointer=middle / -k2
--align-pointer=name / -k3
Attach a pointer or reference operator (*, &, or ^) to either the variable type (left) or variable name (right),
or place it between the type and name (middle). The spacing between the type and name will be preserved, if possible.
This option is for C/C++, C++/CLI, and C# files. To format references separately use the following align-reference
option.
char* foo1;
char & foo2;
String ^s1;
becomes (with align-pointer=type):
char* foo1;
char& foo2;
String^ s1;
char* foo1;
char & foo2;
String ^s1;
becomes (with align-pointer=middle):
char * foo1;
char & foo2;
String ^ s1;
char* foo1;
char & foo2;
String ^s1;
becomes (with align-pointer=name):
char *foo1;
char &foo2;
String ^s1;
--align-reference=none / -W0
--align-reference=type / -W1
--align-reference=middle / -W2
--align-reference=name / -W3
This option will align references separate from pointers. Pointers are not changes by this option. If pointers
and references are to be aligned the same, use the previous align-pointer option. The option align-reference=none
will not change the reference alignment. The other options are the same as for align-pointer. This option is for
C/C++, C++/CLI, and C# files.
char &foo1;
becomes (with align-reference=type):
char& foo1;
char& foo2;
becomes (with align-reference=middle):
char & foo2;
char& foo3;
becomes (with align-reference=name):
char &foo3;
--break-closing-brackets / -y
When used with --style=java, --style=kr, --style=stroustrup, --style=linux, or --style=1tbs, this breaks closing
headers (e.g. 'else', 'catch', ...) from their immediately preceding closing brackets. Closing header brackets
are always broken with the other styles.
void Foo(bool isFoo) {
if (isFoo) {
bar();
} else {
anotherBar();
}
}
becomes (a broken 'else'):
void Foo(bool isFoo) {
if (isFoo) {
bar();
}
else {
anotherBar();
}
}
--break-elseifs / -e
Break "else if" header combinations into separate lines. This option has no effect if keep-one-line-statements
is used, the "else if" statements will remain as they are.
If this option is NOT used, "else if" header combinations will be placed on a single line.
if (isFoo) {
bar();
}
else if (isFoo1()) {
bar1();
}
else if (isFoo2()) }
bar2;
}
becomes:
if (isFoo) {
bar();
}
else
if (isFoo1()) {
bar1();
}
else
if (isFoo2()) {
bar2();
}
--add-brackets / -j
Add brackets to unbracketed one line conditional statements (e.g. 'if
', 'for
',
'while
'...). The statement must be on a single line. The brackets will be added according to
the currently requested predefined style or bracket type. If no style or bracket type is requested the brackets
will be attached. If --add-one-line-brackets is also used the result will be one line brackets.
if (isFoo)
isFoo = false;
becomes:
if (isFoo) {
isFoo = false;
}
--add-one-line-brackets / -J
Add one line brackets to unbracketed one line conditional statements (e.g. 'if
', 'for
',
'while
'...). The statement must be on a single line. The option implies --keep-one-line-blocks and
will not break the one line blocks.
if (isFoo)
isFoo = false;
becomes:
if (isFoo)
{ isFoo = false; }
--remove-brackets / -xj
Remove brackets from conditional statements (e.g. 'if
', 'for
', 'while
'...).
The statement must be a single statement on a single line. If --add-brackets or --add-one-line-brackets is also
used the result will be to add brackets. Brackets will not be removed from "One True Brace Style", --style=1tbs.
if (isFoo)
{
isFoo = false;
}
becomes:
if (isFoo)
isFoo = false;
--keep-one-line-blocks / -O
Don't break one-line blocks.
if (isFoo)
{ isFoo = false; cout << isFoo << endl; }
remains unchanged.
--keep-one-line-statements / -o
Don't break complex statements and multiple statements residing on a single line.
if (isFoo)
{
isFoo = false; cout << isFoo << endl;
}
remains unchanged.
if (isFoo) DoBar();
remains unchanged.
--convert-tabs / -c
Converts tabs into spaces in the non-indentation part of the
line. The number of spaces inserted will maintain the spacing of the tab. The current setting for spaces per tab
is used. It may not produce the expected results if convert-tabs is used when changing spaces per tab. Tabs are
not replaced in quotes.
--close-templates / -xy
Closes whitespace in the angle brackets of template definitions. Closing the ending angle brackets is now allowed
by the C++11 standard. Be sure your compiler supports this before making the changes.
Stack< int,List< int > > stack1;
becomes:
Stack<int,List<int>> stack1;
/*
* comment line 1
* comment line 2
*/
becomes:
/*
comment line 1
comment line 2
*/
--max-code-length=# / -xC#
--break-after-logical / -xL
The option max‑code‑length will break a line if the code exceeds #
characters. The valid values are 50 thru 200. Lines without logical conditionals will break on a logical conditional
(||, &&, ...), comma, paren, semicolon, or space.
Some code will not be broken, such as comments, quotes, and arrays. If used with keep‑one‑line‑blocks
or add-one-line-brackets the blocks will NOT be broken. If used with keep‑one‑line‑statements
the statements will be broken at a semicolon if the line goes over the maximum length. If there is no available
break point within the max code length, the line will be broken at the first available break point after the max
code length.
By default logical conditionals will be placed first on the new line. The option break‑after‑logical
will cause the logical conditionals to be placed last on the previous line. This option has no effect without
max‑code‑length.
if (thisVariable1 == thatVariable1 || thisVariable2 == thatVariable2 || thisVariable3 == thatVariable3)
bar();
becomes:
if (thisVariable1 == thatVariable1
|| thisVariable2 == thatVariable2
|| thisVariable3 == thatVariable3)
bar();
becomes (with break‑after‑logical):
if (thisVariable1 == thatVariable1 ||
thisVariable2 == thatVariable2 ||
thisVariable3 == thatVariable3)
bar();
--mode=c
--mode=cs
--mode=java
Indent a C type, C#, or Java file. C type files are C, C++, C++/CLI, and Objective-C. The option is usually
set from the file extension for each file. You can override the setting with this entry. It will be used for all
files regardless of the file extension. It allows the formatter to identify language specific syntax such as C++
classes, templates, and keywords.
Objective‑C Options
Because of the longer indents sometimes needed for Objective‑C, the option "max-instatement-indent" may
need to be increased. If you are not getting the paren and square bracket alignment you want, try increasing this
value. The option is described in the "Indentation Options" section.
--align-method-colon / -xM
Align the colons in Objective‑C method declarations. This option is effective for Objective‑C
files only.
-(void)deleteKey:(id)key
atIndex:(int)index
ofNode:(Node*)node;
becomes:
-(void)deleteKey:(id)key
atIndex:(int)index
ofNode:(Node*)node;
--pad-method-prefix / -xQ
Insert space padding after the '-' or '+' Objective‑C method prefix. This will add exactly one space. Any
additional spaces will be deleted. This option is effective for Objective‑C files only.
-(void)foo1;
+(void)foo2;
becomes:
- (void)foo1;
+ (void)foo2;
--unpad-method-prefix / -xR
Remove all space padding after the '-' or '+' Objective‑C method prefix. If used with pad‑method‑prefix,
this option will be ignored. This option is effective for Objective‑C files only.
- (void)foo1;
+ (void)foo2;
becomes:
-(void)foo1;
+(void)foo2;
--pad-method-colon=none / -xP0
--pad-method-colon=all / -xP1
--pad-method-colon=after / -xP2
--pad-method-colon=before / -xP3
Add or remove space padding before or after the colons in an Objective‑C method call. These options will
pad exactly one space. Any additional spaces will be deleted. Colons immediately preceding a paren will not be
padded. This option is effective for Objective‑C files only.
with pad-method-colon=none:
[node insertKey:key];
with pad-method-colon=all:
[node insertKey : key];
with pad-method-colon=after:
[node insertKey: key];
with pad-method-colon=before:
[node insertKey :key];
Other Options
--suffix=####
Append the suffix #### instead of '.orig' to original filename (e.g. --suffix=.bak
).
If this is to be a file extension, the dot '.' must be included. Otherwise the suffix will be appended to the
current file extension.
--suffix=none / -n
Do not retain a backup of the original file. The original file is purged after it is formatted.
--recursive / -r / -R
For each directory in the command line, process all subdirectories recursively. When using the recursive option
the file name statement should contain a wildcard. Linux users should place the filepath and name in double quotes
so the shell will not resolve the wildcards (e.g. "$HOME/src/*.cpp"). Windows users should place the filepath
and name in double quotes if the path or name contains spaces.
--exclude=####
Specify a file or sub directory #### to be excluded from processing.
Excludes are matched from the end of the filepath. An exclude option of "templates" will exclude ALL directories
named "templates". An exclude option of "cpp/templates" will exclude ALL "cpp/templates" directories. You may
proceed backwards in the directory tree to exclude only the required directories.
Specific files may be excluded in the same manner. An exclude option of "default.cpp" will exclude ALL files named
"default.cpp". An exclude option of "python/default.cpp" will exclude ALL files named "default.cpp" contained
in a "python" subdirectory. You may proceed backwards in the directory tree to exclude only the required files.
Wildcards are NOT allowed. There may be more than one exclude statement. The filepath and name may be placed in
double quotes (e.g. ‑‑exclude="foo bar.cpp").
--ignore-exclude-errors / -i
Allow processing to continue if there are errors in the "exclude=###" options.
This option lets the excludes for several projects be entered in a single option file. This option may be placed
in the same option file as the excludes. It will display the unmatched excludes. The following option will not
display the unmatched excludes.
--ignore-exclude-errors-x / -xi
Allow processing to continue if there are errors in the "exclude=###" options.
This option lets the excludes for several projects be entered in a single option file. This option may be placed
in the same option file as the excludes. It will NOT display the unmatched excludes. The preceding option will
display the unmatched excludes.
--errors-to-stdout / -X
Print errors to standard-output rather than to standard-error.
This option should be helpful for systems/shells that do not have this option, such as in Windows95.
--preserve-date / -Z
Preserve the original file's date and time modified. The time modified will be changed a few micro seconds to
force the changed files to compile. This option is not effective if redirection is used to rename the input file.
--verbose / -v
Verbose display mode. Display optional information, such as release number and statistical data.
--formatted / -Q
Formatted files display mode. Display only the files that have been formatted. Do not display files that
are unchanged.
--quiet / -q
Quiet display mode. Suppress all output except error messages.
--lineend=windows / -z1
--lineend=linux / -z2
--lineend=macold / -z3
Force use of the specified line end style. Valid options are windows (CRLF), linux (LF), and macold (CR). MacOld
style is the format for Mac OS 9 and earlier. OS X uses the Linux style. If one of these options
is not used the line ends will be determined automatically from the input file.
When redirection is used on Windows the output will always have Windows line ends. This option
will be ignored.
Command Line Only
These options are available for the command-line only. They are NOT available in an options file.
--options=####
Specify an options file #### to read and use. It must contain a file path for the file. This will allow the file
name to be changed from astylerc or .astylerc.
--options=none
Disable the default options file. Only the command-line parameters will be used.
--ascii / -I
The displayed output will be ascii characters only. The text will be displayed in English and numbers will not
be formatted. The short option must be by itself, it cannot be concatenated with other options.
--version / -V
Print version number and quit. The short option must be by itself, it cannot be concatenated with other options.
--help / -h / -?
Print a help message and quit. The short option must be by itself, it cannot be concatenated with other options.
astyle/doc/index.html 100777 0 0 25700 12235007664 10271 0
Artistic Style - Index
Artistic Style 2.04
A Free, Fast and Small Automatic Formatter
for C, C++, C++/CLI, C#, and Java Source Code
Artistic Style is a source code indenter, formatter, and beautifier for the C, C++, C# and Java programming languages.
When indenting source code, we as programmers have a tendency to use both spaces and tab characters to create
the wanted indentation. Moreover, some editors by default insert spaces instead of tabs when pressing the tab
key, and other editors (Emacs for example) have the ability to "pretty up" lines by automatically setting up the
white space before the code on the line, possibly inserting spaces in a code that up to now used only tabs for
indentation.
Since the NUMBER of space characters showed on screen for each tab character in the source code changes between
editors (unless the user sets up the number to his liking...), one of the standard problems programmers are facing
when moving from one editor to another is that code containing both spaces and tabs that was up to now perfectly
indented, suddenly becomes a mess to look at when changing to another editor. Even if you as a programmer take
care to ONLY use spaces or tabs, looking at other people's source code can still be problematic.
To address this problem, Artistic Style was created – a filter written in C++ that automatically re-indents and
re-formats C / C++ / C# / Java source files. It can be used from a command line, or it can be incorporated as
classes in another C++ program.
There is complete documentation for using Artistic Style. Most documentation is included in the distribution package.
Information on the changes in the current release. The News contains information on major changes and how they
might affect the use of Artistic Style. The Release Notes contains a list of all changes made to the program.
Information on old releases is also listed.
The latest release can be downloaded from the SourceForge file releases page. A link to the "latest version" near
the top of the page will download the correct package for your platform. Or you can select the appropriate
package from the "astyle" release folders. The Windows package contains a compiled binary. Other platforms
will need to compile the source code. Makefiles are included for the most popular compilers. Follow the install
instructions for the appropriate platform as described in the "Install" documentation.
The latest development files can be checked out from the Artistic Style repository using Subversion.
Information on compiling and installing Artistic Style. The Windows platform comes with a precompiled
executable. Other platforms must compile the project. Follow the instructions for the appropriate platform (Linux,
Mac, or Windows).
Artistic Style may be used and distributed under version 3 the
GNU Lesser General Public License (LGPL). The LGPL is a set of additional permissions added to version
3 of the GNU General Public License . You can use Artistic Style
in free or commercial software without charge. Projects that use Artistic Style do not have to make the source
code available. If Artistic Style itself is modified, however, the modified Artistic Style source code must be
made available.
This page contains scripts to support the Artistic Style program. They are in various script languages and work
on different platforms. It includes scripts to clean the directories of backup files created by Artistic Style.
There are several applications that use Artistic Style as contributed software. It is either embedded in the application
or called as a command line program. The applications include Graphical User Interfaces to view the effect of
formatting on the source code, development environments for various platforms, and other software.
Artistic Style has compile options for creating a shared library (DLL) or static library for use with a Graphical
User Interface (GUI). With the Java Development Kit (JDK) installed it can be compiled as a Java Native Interface
(JNI) and called from a Java program. The Developer Information documents the calling procedure and has example
programs for C++, Java, C#, and Python.
Bug Reports, Change Requests, Notification
Bug reports and change requests should be submitted to the
bug tracker page . You must be logged in to SourceForge to submit a report. If possible include an example
that shows the problem. It does not need to be functional code. Note that code copied and pasted into the bug
report will not be indented after the data is submitted. You must indicate the indentation when
you submit the request (e.g. replace leading spaces with periods).
New releases are announced through an astyle-announce
mailing list. You will receive notification of new releases and important repository commits. No SourceForge user
account is needed, but registered site users can subscribe using their SourceForge mail alias. (Mail aliases take
the form: username@users.sourceforge.net). The sign-up page can also be accessed from the
user support page . There are other ways to subscribe on the
file releases page that use an RSS feed. You can use them if you want.
To contact the project by email use the address jimp03@email.com .
Maintainers
Artistic Style is maintained and updated by Jim Pattee . The original author
was Tal Davidson, Israel.
Acknowledgments
Thanks to Jim Watson, Fred Shwartz, W. Nathaniel Mills III, Danny Deschenes, Andre Houde,
Richard Bullington, Paul-Michael Agapow, Daryn Adler, Dieter Bayer, Sam Cooler, Jim Duff,
Emilio Guijarro, Jens Krinke, Eran Ifrah, Travis Robinson, Max Horn, Ettl Martin,
Mario Gleichmann, J P Nurmi, Colin D Bennett, Christian Stimming, MrTact, Wim Rosseel,
Matthew Woehlke, Chris Schwarz, Chang Jiang, Arseny Solokha, Milian Wolff, Johannes Martin,
Arne F?rlie, Marvin Humphrey, J, Christopher Sean Morrison, Keith OHara, louis6g, Evmenov Georgiy,
beta100100, Ruzzz for their patches and contributions to Artistic Style.
Thanks to SourceForge for giving Artistic Style its home.
Thanks to all the dedicated beta-testers and bug notifiers!
astyle/doc/install.html 100777 0 0 43652 12235007664 10636 0
Artistic Style - Install Information
Artistic Style Install Information
Contents
Artistic Style Versions
Linux Version
GCC Compiler
Other Makefile Options
Clang Compiler
Intel Compiler
Mac OS X Version
Windows Version
Precompiled Executable
Visual C++ Compiler
Other Compilers
Compiler Options
Artistic Style Versions
astyle_x.x_linux.tar.gz is the Linux version of Artistic Style. It contains the source code, documentation,
and makefiles. The Linux Version compile instructions below give information for compiling the source code.
astyle_x.x_macosx.tar.gz is the Mac OS X version of Artistic Style. It contains the source code, documentation,
and a makefile. The Mac OS X Version compile instructions below give information for compiling the source code.
astyle_x.x_windows.zip is the Windows version of Artistic Style. It contains the source code, documentation,
Visual C project files, and an executable. The Windows Version compile instructions below give information for
compiling the source code.
Only one platform is supported in each distribution package. If you use Artistic Style on more than one platform
you will need to download packages for each platform. The main difference in platforms is the build directories
and the line endings. Most compilers and development packages will accept any type of line ending. The source
code and documentation are the same for all distributions.
Linux Version
GCC Compiler
To compile using the GCC compiler you must have GCC (3.1 or better) installed.
The build has no autoconf dependency. To build the Artistic Style configurations use the makefile located in the
astyle/build/gcc directory. The executables will be in the astyle/build/gcc/bin directory. To build the command
line configuration enter the following:
cd astyle/build/gcc make
To build the other astyle configurations you can enter the file name or a symbolic name. Entering "make astyle"
or "make release" will build the command line configuration. Following are the symbolic names and file names (in
parens) of the various configurations:
release builds the Artistic Style command line program (astyle). This is the default option.
shared builds the Artistic Style program as a shared library (libastyle.so).
static builds the Artistic Style program as a static library (libastyle.a).
debug builds the Artistic Style command line program with debugging information (astyled).
shareddebug builds the Artistic Style program as a shared library with debugging information (libastyled.so).
staticdebug builds the Artistic Style program as a static library with debugging information (libastyled.a).
all builds all of the above configurations.
The following Java shared library builds are separate from the above. They include a Java Native Interface (JNI)
and require that the Java Development Kit (JDK) be installed. The environment variable JAVA_HOME should be defined.
It defines the install directory for the JDK. The makefile also has default install directories for Java 5 and
6. If the compile cannot find the file jni.h, either set the variable or change the value in the makefile.
java builds the Artistic Style program as a shared library which includes the JNI (libastylej.so).
javadebug builds the Artistic Style program as a shared library which includes the JNI and debugging information
(libastylejd.so).
javaall builds all of the above java configurations.
More than one configuration can be built at the same time. For example, to build all of the release configurations
enter:
cd astyle/build/gcc make release shared static
Other Makefile Options
The following makefile options are available for GCC, Clang, Intel, and Mac.
clean
Removes the object and executable files for all configurations.
To remove the files for all configurations:
make clean
cleanobj
Removes the object files for all configurations. The executables will not be removed.
To remove only the object files for all configurations:
make cleanobj
install
Installs the executable and documentation files. The default is /usr/bin for the executable and /usr/share/astyle
for the documentation. You must have the appropriate permissions to use install.
To install the astyle to the default directories:
make install
To install astyle to a different bin directory set a value for the macro $(prefix). For example to install the
executable to a user's home directory (/home/user /bin):
make prefix=$HOME install
uninstall
Uninstalls the executable and documentation. You must have the appropriate permissions to use uninstall.
To uninstall astyle from the default directories:
make uninstall
To uninstall the files from a different directory set a value for the macro $(prefix). For example to uninstall
the files from a user's home directory (/home/user ):
make prefix=$HOME uninstall
NOTE: The uninstall option will NOT remove the .astylerc files from the users home directories. The files must
be removed individually for each user.
Clang Compiler
The Clang Compiler release 2.9.11 has a problem finding object files on
some distributions (Ubuntu based). There is a script file, copyfiles.sh, that will copy three object files to the clang build directory
so they can be linked. The directory may need to be modified for your distribution. Or, you may not need it at all.
This problem has been fixed in version 3.0.
Clang has a static analyzer that finds potential bugs in C/C++ and Objective-C programs. It can be run as a standalone
tool from the command-line, and runs in tandem with a build. There is a script file, analyze.sh, that will run
the analysis on Artistic Style.
The build has no autoconf dependency. To build the Artistic Style configurations use the makefile located in the
astyle/build/clang directory. The executables will be in the astyle/build/clang/bin directory. To build the command
line configuration enter the following:
cd astyle/build/clang make
To build the other astyle configurations you can enter the file name or a symbolic name. The configurations for
Clang are the same as for the GCC compiler . More than one configuration can be
built at the same time. For example, to build all of the release configurations enter:
cd astyle/build/clang make release shared static
The Other Makefile Options are the same as for the GCC compiler.
Intel Compiler
The compiler release should be 2011.1.107 or higher. These procedures and the makefile will not
work for earlier versions.
To compile the source there are environment variables that must be set. If this has not been done already enter:
"source <install-dir>/bin/iccvars.sh <arg> ", where <install-dir>
is the directory where the compiler is installed and <arg> is ia32 or intel64
. On an Intel x64 platform installed in the default directory the instruction would be
source /opt/intel/bin/iccvars.sh intel64
If this is not done the make will display an error message "*** No rule to make target `obj/astyle_main.o', needed
by `astyle'." Instructions for the options are in the compiler documentation file "getting_started_c.pdf" in the
section "Starting the Compiler from the Command Line".
The build has no autoconf dependency. To build the Artistic Style configurations use the makefile located in the
astyle/build/intel directory. The executables will be in the astyle/build/intel/bin directory. To build the command
line configuration enter the following:
cd astyle/build/intel make
To build the other astyle configurations you can enter the file name or a symbolic name. The configuration names
for Intel are the same as for the GCC compiler . More than one configuration can be
built at the same time. For example, to build the entire debug configurations enter:
cd astyle/build/intel make debug shareddebug staticdebug
The Other Makefile Options are the same as for the GCC compiler.
Mac OS X Version
The build has no autoconf dependency. To build the Artistic Style configurations use the makefile located in the
astyle/build/mac directory. The executables will be in the astyle/build/mac/bin directory. To build the command
line configuration enter the following:
cd astyle/build/mac make
To build the other astyle configurations you can enter the file name or a symbolic name. The configurations for
Mac are the same as for the Linux GCC compiler . More than one configuration can be
built at the same time. For example, to build all of the release configurations enter:
cd astyle/build/mac make release shared static
The Other Makefile Options are the same as for the Linux GCC compiler.
Windows Version
Precompiled Executable
In addition to the source files, the Windows distribution package contains an Artistic Style Win32 executable
(AStyle.exe). If you prefer to compile the executable yourself follow the following instructions.
Visual C++ Compiler
There are configuration and project files for 3 versions of the Visual C compiler; build/vs2005 (Visual Studio
2005), build/vs2008 (Visual Studio 2008) and build/vs2010 (Visual Studio 2010). Open the AStyle configuration
file in the appropriate "build" directory. All project files have Debug, Release and Static configurations.
Debug file output will be in the "debug" directory. Release file output will be in the "bin"
directory. Static file output will be in the "binstatic" directory. The following solution files are available.
All AStyle builds the release and the debug configurations for all of the following.
AStyle builds the Artistic Style command line program (AStyle.exe). This project has an extra "Static" option.
It is the same as the "Release" build except that it is linked with a static runtime library. This is needed if
the executable is to be run on a system without Visual Studio installed. The builds for this configuration are
placed in a separate "binstatic" directory.
AStyleDll builds the Artistic Style program as a Dynamic Link Library (AStyle.dll). This will also build
an exports library and a static library for linking the dll.
AStyleJava builds the Artistic Style program as a Dynamic Link Library (AStylej.dll) that can be called
from a Java program. The Java Development (JDK) is required for the project to compile. This builds the Artistic
Style as a Dynamic Link Library (AStylej.dll) that can be called from a Java program. The Project Properties must
have an include path to the JDK include and include/win32 directories. This is set in "Project > Properties
> C/C++ > General > Additional Include Directories". The default setting is for the JDK
to be installed in the default directory, but it may not be the most current release. The output DLL can also
be called from a C++ or C# program.
AStyleLib builds the Artistic Style program as a Static Library (libAStyle.lib). This can be statically
linked to a calling program.
Other Compilers
To use other compilers a project file must be built using a development environment.
Create a project using the compiler's development environment
Add to the project all the .cpp and .h files in the "src" directory.
The Compiler Options section discusses the compiler options to use.
Compile.
Compiler Options
No macro definitions are required to compile the executable. To compile as a static or shared (dynamic) library
define the macro ASTYLE_LIB. To compile a Java shared (dynamic) library define the macro ASTYLE_JNI. Then use
the appropriate compiler and linker options to compile the static or shared library. Add debug options to compile
the debug versions.
Artistic Style is a small program and it is best to optimize for speed. The debug configurations are not usually
optimized. To optimize for speed in the release configurations use the macro NDEBUG to remove asserts. If
necessary, use an option to activate the C++11 standards (--std=c++0x on GCC and MinGW). Use an
option that allows inline function expansion. Runtime Type Information (RTTI) is NOT needed. Exceptions are not
used. Use whole program optimization if your compiler supports it. There may be other options you can use depending
on the compiler.
astyle/doc/license.html 100777 0 0 26534 12235007664 10612 0
Artistic Style License
Artistic Style License
Artistic Style may be used and/or modified and/or distributed under
the GNU Lesser General Public License (LGPL) , as detailed
below. The LGPL is a set of additional permissions added to version 3 of the
GNU General Public License .
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/ >
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not
allowed.
This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the
GNU General Public License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, “this License” refers to version 3 of the GNU Lesser General Public License, and the
“GNU GPL” refers to version 3 of the GNU General Public License.
“The Library” refers to a covered work governed by this License, other than an Application or a Combined
Work as defined below.
An “Application” is any work that makes use of an interface provided by the Library, but which is
not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of
using an interface provided by the Library.
A “Combined Work” is a work produced by combining or linking an Application with the Library. The
particular version of the Library with which the Combined Work was made is also called the “Linked Version”.
The “Minimal Corresponding Source” for a Combined Work means the Corresponding Source for the Combined
Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on
the Application, and not on the Linked Version.
The “Corresponding Application Code” for a Combined Work means the object code and/or source code
for the Application, including any data and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU
GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be
supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked),
then you may convey a copy of the modified version:
a) under this License, provided that you make a good faith effort to ensure that, in the event an Application
does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains
meaningful, or
b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from a header file that is part of the Library.
You may convey such object code under terms of your choice, provided that, if the incorporated material is not
limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library
and its use are covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification
of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications,
if you also do each of the following:
a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library
and its use are covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the
Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license
document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application
Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with
a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section
6 of the GNU GPL for conveying Corresponding Source.
1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a)
uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly
with a modified version of the Library that is interface-compatible with the Linked Version.
e) Provide Installation Information, but only if you would otherwise be required to provide such information under
section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified
version of the Combined Work produced by recombining or relinking the Application with a modified version of the
Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding
Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information
in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the Library side by side in a single library together
with other library facilities that are not Applications and are not covered by this License, and convey such a
combined library under terms of your choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other
library facilities, conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License
from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail
to address new problems or concerns.
Each version is given a distinguishing version number. If the Library as you received it specifies that a certain
numbered version of the GNU Lesser General Public License “or any later version” applies to it, you
have the option of following the terms and conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you received it does not specify a version number
of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License
ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser
General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization
for you to choose that version for the Library.
astyle/doc/links.html 100777 0 0 27743 12235007664 10313 0
Artistic Style - Links
Artistic Style Links
Information
Indent Style
at Wikipedia discusses the common indent styles used in programming. The basic criteria for most Artistic Style
predefined styles were taken from this discussion.
Programming
style at Wikipedia is a set of rules or guidelines used when writing the source code for a computer
program. It is often claimed that following a particular programming style will help programmers to read and understand
source code conforming to the style, and help to avoid introducing errors.
The google‑styleguide
website has google standards for several programming languages along with a python program to verify the style and
an emacs script for using the style.
Graphical User Interfaces
Artistic Style is a command line program and, as such, does not give you a chance to review the effect of different
options before formatting the source code. The following Graphical User Interface program will allow you to review
the changes before the code is updated. They allow you to select the options you want without actually updating
the source.
Artistic Style for Windows
is an Artistic Style GUI program for Windows. It uses an unmodified Artistic Style program in a Windows GUI. It
will work under Linux using WINE. Everything done in the editor is undo-able, including formatting of the entire
document. Documents can be reviewed and reformatted using different options. It can be executed from most development
environments and will open the currently selected document.
Universal Indent
Gui is a cross platform GUI that supports several code formatters. The main feature is a live
preview to show how the selected formatting options affect the source code. This allows review and testing of
the various options before formatting a file. It can be used with a sample file or with your actual source code.
It is a good way to try out the options from various indentation programs. This program is not always kept up
to date. Be sure to check the AStyle release before relying on the results.
Development Environments
The following development environments use Artistic Style as a contributed add-on. It is either embedded in the
application or called as a command line program.
CodeBlocks is
a multi-platform, open source, C++ development environment based on wxWidgets . It has support for multiple compilers and plug-ins for wxWidgets development.
CodeLite is an
open source, cross platform development environment for C++. It has support for wxWidgets and includes a class
generator and a unit test program generator. Code completion is based on Ctags .
KDevelop is a
multi-platform, integrated development environment for building
KDE applications. It supports many programming languages and can be used to develop applications other
than KDE.
Monkey Studio
is a cross platform IDE written in C++/Qt. Its primary goal was to be a Qt only IDE, but it evolved into a way to support Qt development and any kind
of project.
QDevelop
is a free cross-platform development environment entirely dedicated to Qt . Artistic Style is available as a plug-in on the Download page.
tIDE is
a full featured open source
Java integrated development environment. It is a small, powerful, quick, efficient, easy and open framework
to create 100% Java applications.
Other Programs
These programs were mentioned in previous versions of the News. They are included here for reference.
AStyle Extension is an extension for Visual Studio, AVR Studio and Atmel studio to format C/C++
and C# documents using Artistic Style engine. It is written in C# using the AStyle.dll. It can be installed to
Visual Studio Professional (or above). Unfortunately it will not install in Visual Studio Express. Source code
is currently available at
Google Code .
Google Test
and Google Mock
are frameworks for writing C++ tests on a variety of platforms. Based on the xUnit architecture it supports automatic
test discovery, a rich set of assertions, user-defined assertions, death tests, fatal and non-fatal failures,
value- and type-parameterized tests, various options for running the tests, and XML test report generation. Google
Mock is a library for writing and using C++ mock classes.
Highlight converts source code to formatted text with syntax
highlighting. Output is in several formats including HTML. It supports over 160 programming languages and includes
80 color themes. Highlight is used for the examples in the "Developer Information" section.
Python Tools for Visual Studio
is a free, open source plug-in that turns Visual Studio into a Python IDE. It can be switched between Python versions
or different Python interpreters. It uses the Visual Studio integrated debugger that enables you to set break
points, step through functions, change the current statement, inspect local variables, and perform other operations
while debugging.
SciTE
is a Scintilla based source code editor. Originally built to demonstrate Scintilla , it has grown to be a generally useful editor with facilities for building
and running programs. It is currently available for Windows, Linux, and Mac OS X operating systems. The Linux
and Mac versions are based on GTK+ .
Visual Leak Detector for Visual
C++ is leak finder program for Visual Studio. It can be downloaded from the website for Express
editions or installed for standard versions from the "Tools > Extensions and Updates" menu. When you run a
program under the Visual Studio debugger Visual Leak Detector will output a memory leak report at the end of the
debugging session.
Other Links
These links were mentioned in previous versions of the News. They are included here for reference.
Install Instructions for .NET Framework SDK
are instructions for adding x64 platforms to Visual Studio Express 2010. Express editions after 2010 have the
x64 platforms already installed. Visual Studio 2010 is the last edition that will work on Windows XP (platform
toolset v100). Visual Studio 2012 (platform toolset v110) and higher contains dependencies on Windows API functions
that exist only on Windows Vista, Windows 7, and Windows 8. This means that applications built with Visual Studio
2012 and higher would fail to load and execute on Windows XP.
Survey
General Information and Survey Options are the results of an Artistic Style survey
from May 2011. There is a commentary on the survey in the May 2011 News under the heading "Survey Results".
astyle/doc/news.html 100777 0 0 100534 12235007664 10155 0
Artistic Style - News
Artistic Style News
Artistic Style 2.04 (November 2013)
With a new Artistic Style release some unchanged source files will be formatted because of changes to Artistic
Style. You may want to format your source before making program changes in order to bring it up to date.
A new programming language, Objective‑C, has been added to Artistic Style. Four new options, "align‑method‑colon",
"pad‑method‑colon=", "pad‑method‑prefix", and "unpad‑method‑prefix" have been
added to format the methods. The options are described in a new "Objective‑C" section in the documentation.
These new options affect only Objective‑C source code. They have no effect on the other programming languages.
Because of the longer continuation indents sometimes needed for Objective‑C, the option "max-instatement-indent"
may need to be increased. If you are not getting the paren and square bracket alignment you want, try increasing
this value. The default minimum is 40 and the maximum is 120.
A new bracket style option, "style=google", has been added. It uses attached brackets and indents the class access
modifiers one-half indent. A complete description of the Google
style is available at the
google‑styleguide website (https://code.google.com/p/google-styleguide/). The website has standards
for several programming languages along with a python program to verify the style and an emacs script for using
the style.
A new indent option "indent-modifiers" will indent class access modifiers (public, protected, or 'private) one-half indent.
The rest of the class is not indented. It is described in the "Indentation Options" section of the documentation.
Four new bracket modify options, "attach-namespaces", "attach-classes", "attach-inlines", and "attach-extern-c",
can be used to modify your selected bracket style. They are described in a new "Bracket Modify Options" section
of the documentation.
A new option, "remove-brackets", will remove brackets from conditional statements. The statement must be a single
statement on a single line. It is described in the "Formatting Options" section of the documentation.
A new option, "indent-preproc-cond", will indent preprocessor conditional statements (#if #elif, #else, #endif).
It is described in the "Indentation Options" section of the documentation. The option "indent-preprocessor" has
been deprecated and will be removed in a future release. Use "indent-preproc-define" instead. The processing of
preprocessor #define statements has not changed.
A new option, "remove-comment-prefix", will remove a leading '*' from multi-line comments. It is described in
the "Formatting Options" section of the documentation. With the syntax coloring of modern editors a leading '*'
for comment lines is not as useful as it once was. The current trend is toward code that is easier to maintain. The idea is
that a style that is hard to maintain will discourage modification and updating. The converted style should retain
most of the formatting within the comment and result in a comment that is easier to maintain. For consistency
the option also indents multi-line comments that are not preceded by the '*'. This may slightly modify the indentation
of any commented-out code.
The option "pad-first-paren-out" was fixed to not pad if the following paren is empty. This makes the option consistent
with "pad-paren-out". To fix empty parens that have been padded run with the option "unpad-paren" in addition
to "pad-first-paren-out". This needs to be done only once.
Processing of C++11 raw string literals has been added.
A new shared object (DLL) entry point, AStyleMainUtf16, has been added for processing C# UTF-16 strings. C# does
not have built in functions for converting the UTF-16 strings to UTF-8. This
entry point will accept UTF-16 strings, format the source code, and return UTF-16 strings. The error handling
function and version number still use UTF-8 strings. The C# example program in the "Developer Information" shows
the new calling procedure. Changes from the previous release are marked in the example.
C# strings are UTF-16 on both Windows and Linux. C# does not use the UTF-32 wchar_t strings on Linux. Qt also
uses UTF-16 on both Windows and Linux, but has built in UTF-8 conversion functions. Qt strings can be converted
to UTF-8 by Qt, or the new entry point can be used. There may be other "managed code" applications on Linux that
use UTF-16.
The "Links" page has two new sections for links mentioned in previous versions of Artistic Style. It links to
free software and other information.
The "Developer Information" section has a new example and download for calling Artistic Style from an Objective‑C
program. Since it is another "C" language the only thing needed is to link the program with a library build of
Artistic Style. The example was developed on Windows and Linux using the GNUstep project. Since the example is
a console program the problems with the GNUstep GUI have been avoided. It has not been tested on a Mac, but should
be close to working. The "Developer Information" section also has new page for "Objective‑C on Windows and
Linux" which has information on compiling and running the example on those systems.
The executable included in the Windows distribution was compiled with Visual Studio 2010 (platform toolset v100).
Higher releases contain dependencies on Windows API functions that exist only on Windows Vista, Windows 7, and
Windows 8. This means that applications built with a Visual Studio 2012 C++ compiler would fail to load and execute
on Windows XP.
If you
are using Windows Vista or higher, and have a Visual Studio 2012 or higher compiler available, recompiling will
probably result in faster execution. If you use a compiler other than Visual Studio, you can probably get
better execution by compiling using the C++11 standards. Artistic Style uses a lot of string vectors and the new
move semantics will probably result in faster execution.
Thanks to Evmenov Georgiy, Matthew Woehlke, Jiang, Ruzzz, and beta100100 for their contributions.
Artistic Style 2.03 (April 2013)
With a new Artistic Style release some unchanged source files will be formatted because of changes to Artistic
Style. You may want to format your source before making program changes in order to bring it up to date.
A new option, "max-code-length=#" or "xC#", will limit the length of code on a line. A new option "break‑after‑logical",
or "xL", will modify a line break for conditionals. See the documentation for details.
A new option, "pad-first-paren-out" or "xd", will pad only the first paren in a series on the outside. See the
documentation for details.
A new option, "indent=force-tab-tab=#" or "xT#", will allow force tab indents with a tab length that is different
than the indent length. See the documentation for details.
The short option for delete-empty-lines has changed from "xd" to "xe".
The C++11 standard for range-based "for" loops, "enum" with a base type, and rvalue references is now supported.
The formatting of rvalue references is determined from the existing "align-pointer" and "align-reference"
options.
Closing the ending angle brackets of templates is now allowed by the C++11 standard. A new option, "close-templates"
or "xy", will close the whitespace in the angle brackets of template definitions. Be sure your compiler supports
this before making the changes.
The C/C++ keyword 'extern "C"' in a preprocessor no longer causes an extra indent.
Formatting of C++/CLI managed pointers (the '^' character) has been added to the "align-pointer"
option.
The breaking of switch "default" statements has been fixed. The "default" statements
that have been incorrectly broken will be fixed in this release.
The byte order mark (BOM) has been removed from ASLocalizer.cpp for all platforms. The encoding of the file is
UTF-8. Many Windows editors can now recognize UTF-8 encoding without the BOM. Visual Studio has an option that
needs to be set. With others. such as CodeBlocks, identification is automatic. On Linux, UTF-8 is the default
encoding.
Translations have been added for Dutch, Finnish, Italian, Japanese, Korean, Polish, Portuguese, Russian, Swedish,
and Ukrainian. The translations were done with an automated translation program, Google Translate, so they may
not be the best translation possible. The translations are at the end of ASLocalizer.cpp in the form of an English‑Translation
pair. If you correct a translation, send the source as a bug report and it will be included in the next release.
To add a language, see "Internationalization" in the "General Information" section of the documentation. Send
the addition as a bug report and it will be included in the next release.
There is a new Linux makefile for the Clang Compiler. Clang is a free compiler can be installed as a package on
many Linux distributions. Some of its features are fast compiles, low memory use, expressive diagnostic messages,
and GCC compatibility. It includes a static analyzer tool that finds potential bugs in your source code. An experimental
version can be installed on a Windows platform. There is more information in the Install Information documentation.
Visual Studio automatically creates an import library and an export file when you link a program that contains
exports. It will do this for even a static library if it contains a __declspec(dllexport) definition. The Artistic
Style library (ASTYLE_LIB) build contains such exports which causes an import library and export file to be created
when they may not be needed. A new preprocessor definition, ASTYLE_NO_VCX (no Visual Studio exports) can be declared
to eliminate the files from the output. Use this only for static libraries or when the AStyle source is included
in the compile. Do NOT use this when compiled as a shared (dynamic) library. It is effective only for Visual Studio
2012. It will NOT work with previous versions. It has no effect with other compilers since they require a separate
option to create the import library and export files.
The executable included in the Windows distribution was compiled with Visual Studio 2010 (platform toolset v100).
Visual Studio 2012 (platform toolset v110) contains dependencies on Windows API functions that exist only on Windows
Vista, Windows 7, and Windows 8. This means that applications built with a Visual Studio 2012 C++ compiler would
fail to load and execute on Windows XP. Artistic Style was therefore compiled with Visual Studio 2010 to work
on computers using Windows XP.
If you are using Windows Vista or higher, and have the Visual Studio 2012 compiler available, recompiling with
Visual Studio 2012 will probably result in faster execution. The Windows distribution has Visual Studio 2012 project
files available.
If you use a compiler other than Visual Studio, you can probably get better execution by compiling using the C++11
standards. Artistic Style uses a lot of string vectors and the new move semantics will probably result in faster
execution. (To use C++11 on GCC and MinGW use the option --std=c++0x). This may change on future compiler releases.).
The "Developer Information" page has a new example and download for calling Artistic Style from a Python script.
It will run with both Python 2 and Python 3. Using Python 3 shows an example of formatting a Unicode string with
Artistic Style. Unicode strings must be encoded to UTF-8 before formatting and decoded back to Unicode afterward.
The example script shows the technique for doing this. It also shows how to set up the function pointers and allocate
memory in Python.
If you use Visual Studio on Windows, it can now be used for Python development. Python Tools for Visual Studio
(PTVS) is a free and open source plug-in for Visual Studio 2010 that supports Python and Iron Python. Other interpreters
such Jython can be added. It can be easily switched between Python versions or different interpreters. But the
best thing is the Visual Studio debugging support using the .NET debugger and the normal Visual Studio debugger.
It enables you to set break points, step through functions, change the current statement, inspect local variables,
and perform other operations while debugging. It is best to use it with a project file, a minor irritation for
single page scripts. And there are some minor bugs. But overall it works quite well.
Thanks to Christopher Sean Morrison, Keith OHara, louis6g, and J for their contributions.
Artistic Style 2.02 (May 2011)
With a new Artistic Style release some unchanged source files will be formatted because of changes to Artistic
Style. You may want to format your source before making program changes in order to bring it up to date.
Release 2.02.1 - November 2011
This bug fix release is issued because of the length of time required for the some of the changes in the next
release (2.03). Bugs with the breaking of "case" statements and a crash with pointer to pointer (**) in align-pointer=type
have been fixed. The "case" statements that have been incorrectly broken will be fixed in this release. Pointers
and references are now processed for C# files. See the "Release Notes" for more information and additional changes.
The following information is for the original 2.02 release.
Translations
A new program module and header, ASLocalizer.cpp and ASLocalizer.h, have been added. These are required for the
console build and are optional for the library builds. It contains language translations for several of the most
common users of Artistic Style. The method used was adapted from the Gnu "gettext" method.
The translation to use is determined from the User Locale for Windows and the LANG environment variable for other
systems. The translation will be done automatically from these settings. If no translation is available it will
default to English.
A new option, "ascii" or "I", will display the text in English regardless of your system settings. This option
must be input from the command line and not an option file. See the documentation for details.
The translations were mostly done with an automated translation program, Google Translate, so they may not be
the best translation possible. The translations are at the end of ASLocalizer.cpp in the form of an English‑Translation
pair. If you correct a translation, send the source as a bug report and it will be included in the next release.
To add a language, add a new translation class to ASLocalizer.h. Add the English‑Translation pair to the
constructor in ASLocalizer.cpp. Update the WinLangCode array, if necessary, and add the language code to the function
setTranslationClass(). The ASLocalizer.cpp program contains comments that give web pages for obtaining the LCIDs
and language codes. Send the source code as a bug report and it will be included in the next release.
Brackets
Since release 1.22 (April 2008) the predefined styles have increased from 5 to 12 and the bracket types have increased
from 4 to 6. Having two different ways of defining bracket styles has resulted in some confusion and unnecessary
duplication. This release starts a redesign of the bracket definitions to simplify the user interface. The predefined
styles and bracket types will be combined into a single option category.
The "Predefined Style" options have been renamed "Bracket Style" options. The "Bracket Options" have been depreciated
and will be removed in a future release. If you are using a "brackets=" option, you should start changing to one
of the "style=" options. There is a "style" option available for every "brackets" option.
All "Bracket Style" options now default to 4 spaces per indent. If you were using a "Predefined Style" with a
default indent other than 4, you will need to add one of the "Tab Options" to maintain the same indentation. The
styles which used indents other than 4 were:
Stroustrup - 5 spaces per indent.
Gnu - 2 spaces per indent.
Linux - 8 spaces per indent.
Horstmann - 3 spaces per indent.
There is a new "Bracket Style" option "style=pico" or "A11". It uses run-in brackets, like Horstmann style, and
attaches the closing bracket to the last line in the block. It sets the options "keep one line blocks" and "keep
one line statements". This is a very compact style and is a good style for small monitors.
Another new "Bracket Style" option is "style=lisp" or "style=python" or "A12". It uses attached brackets, like
Java style, and attaches the closing bracket to the last line in the block. It sets the option "keep one line
statements". This style makes indentation the only way of distinguishing blocks of code, but has the advantage
of containing no uninformative lines. Like Pico, it is also a very compact style.
The option "brackets=horstmann" has been removed. Instead use "style=horstmann" or "A9". The short option "g"
is now equivalent to the new "brackets=run-in". Run-in brackets are used for both Horstmann and Pico styles.
The option "indent-brackets" and short option "B" have been removed. Instead use "style=whitesmith" or "style=banner".
The option "indent-blocks" and short option "G" have been removed. Instead use "style=gnu".
Two new options, "style=break" and "style=attach", have been added for Allman and Java bracket styles respectively.
Other Changes
To allow for future expansion the short options will now allow an "x" prefix to be used. New short options may
start with an "x" and will be followed by another character (e.g. "xa", "xb", "xc" ...). The current options,
with one exception, will still be valid.
The short option for "delete-empty-lines" has been changed from "x" to "xd" to allow for the expansion of short
options.
A new option "align-reference=" (-W#) allows references to be aligned separate from pointers. See the documentation
for details.
Since computer screens are getting wider the maximum value for "max-instatement-indent" has been increased from
80 to 120.
New options ignore‑exclude‑errors (‑i) and ignore‑exclude‑errors‑x (‑xi)
will allow processing to continue if there are errors in the "exclude" options. This lets the excludes for several
projects to be entered in a single option file. The "ignore" options may be placed in the same option file as
the excludes. The ignore‑exclude‑errors option will display the unmatched excludes, ignore‑exclude‑errors‑x
will not display them.
Artistic Style can now format UTF-16 encoded files, both little and big endian. This encoding is the default for
Visual Studio Unicode files. The file is formatted by converting it to UTF‑8 and then back to UTF‑16.
The conversion process does not add a significant amount of time to the formatting. The UTF-16 file must be encoded
with a byte-order-mark (BOM) to be recognized. Again, this is the Visual Studio default.
The Visual Studio project files now have a solution for both Win32 and x64 compiles. The x64 version will be needed
if you are using an Artistic Style DLL for Java or C# on a Windows 7 platform. Or you may just prefer an
x64 console program. The executable included in the Windows distribution is still Win32. It will work on both
Win32 and x64 systems.
If you use Visual Studio C++ Express the 2010 release has the ability to compile x64 code. But you must use Vista
or Windows 7 and need to install the .NET Framework SDK. I have created a brief instruction page here. Note
that a fix is required if you apply Service Pack 1 after installing the .NET Framework SDK.
The documentation contains a new section "Command-line Only" which lists commands that are not available from
an options file. The options were transferred from the "Other Options" section.
Thanks to Milian Wolff, Johannes Martin, and Arne F?rlie, and Marvin Humphrey for their contributions. The UTF‑8
and UTF‑16 conversions were obtained from the SciTE source code editor.
Survey Results
The results of the survey posted last release are available at General Information and Artistic Style Options.
Thanks to everyone who took the time to complete it.
Surveys give an indication of how many people are using an option or want certain features. This is information
that is not available in the bug reports.
In the "Enhancements" group there were three items with multiple requests. The most frequent request by far was
to enforce a maximum line length. This is also the oldest request in the bug reports. Another item with multiple
requests was to disable/enable Artistic Style formatting on request within source files. This is the second oldest
request in the bug reports. A third item with multiple requests was to customize namespace brackets independent
of the requested bracket style. I will try to address these in the next release.
Things that stand out to me in the multiple‑choice sections:
The predefined styles and brackets options were each used about 50% each. That will change with this release.
Over 50% of the survey uses Artistic Style for Windows. I have been working for a couple of years on a new program
based on wxWidgets. I will try to give this more priority in the future.
Over 75% of the survey uses Artistic Style to format entire projects.
About one‑third of the Windows C++ users use Artistic Style for Managed C++.
The most popular option is add‑brackets (60%), which was just recently added.
The attach‑pointer options, in total (70%), are even more popular than add-brackets. They were also recently
added.
The preserve-date option is used by nearly one-third of the survey.
All of the options are used by someone in the survey, even the ones I thought were outdated. The bracket styles
that are not used are probably a result of not having enough response.
Developers
The Artistic Style for Windows program contains a sample GUI using the new bracket style options. The old predefined
styles are now the bracket styles. The bracket options have been removed along with the indent‑brackets
and indent‑blocks options. The new bracket styles all use the same default indent of 4 spaces, therefore
it is not necessary to set an indentation from the bracket style. The new format is available for use with this
release.
Artistic Style 2.01 (November 2010)
With a new Artistic Style release some unchanged source files will be formatted because of changes to Artistic
Style. You may want to format your source before making program changes in order to bring it up to date.
A new feature at SourceForge is download maps that show a list of downloads by country. It is available from the
top menu at Develop > Download Stats (Beta), and clicking on the "top country" area. The list of downloads
shows about 75% of Artistic Style downloads are from non English speaking countries. This release is the start
of the internationalization of Artistic Style.
Artistic Style now sets the native local so that characters from the user’s native language will be recognized
in directory names and file names. Artistic Style for Windows has also been changed to use the native locale.
For Linux systems using UTF-8 locales, characters from any language will be recognized and any combination of
languages can be used. For Windows, only languages recognized by the native codepage can be used. For example,
the English locale (codepage 1252) also has French, German, Italian, Portuguese, Spanish, plus several other languages.
Other locals, such as Chinese and Japanese, only support one language. Unicode was not used due to the varying
degree of support by different compilers for console applications.
The locale setting also affects the way numbers are displayed. Language translations may be provided in a future
release.
This is a major release (2.01) because of the internationalization and changes that will occur in the next couple
of releases. Future releases will contain a major change to the bracket options and a rewrite of the file access
method. Some of the requested changes require looking at blocks of code instead of single lines. The current program
has been patched to do this but a rewrite of the file input is needed. These are both major changes but with the
new test framework in place they should be manageable.
There has been a change to the ‑‑min‑conditional‑indent option. Instead of using the number
of spaces it now uses a code expressed in number of indents. This will allow the option to be set independently
of the spaces per indent. If you are using the default setting of two indents, or a setting of zero indents, there
is no change necessary to the input. Otherwise, check the documentation for the new codes.
The --style=linux has been changed to ALWAYS use a minimum conditional indent of one-half the indent length. This
is in the style definition and cannot be changed. If you do not want this setting use the K&R style instead.
The MFC macros BEGIN_DISPATCH_MAP, BEGIN_EVENT_MAP, and BEGIN_PROPPAGEIDS are now formatted.
Checksum verification has been added to source file output that will help assure that no code has been duplicated
or omitted. This is effective only in the debug configuration used for testing.
The test framework has been changed from UnitTest++ to Google Test, which is actively maintained, has a mock object
framework (Google Mock), and good documentation. Regression and system testing have been automated with Python
scripts. Python has also been used for class verification checks and other repetitive procedures.
If you use Visual Studio C++ Express the 2010 release has the ability to create x64 code. But you must use Vista
or Windows 7 and need to install the .NET Framework SDK. I have created a brief instruction page here.
Thanks to Matthew Woehlke, Chris Schwarz, Chang Jiang, and Arseny Solokha for their contributions.
Developers
On the library build of Artistic Style, the second argument of the fpError typedef and the javaErrorHandler declaration
has been changed from "char*" to "const char*". This could cause a compile error if not changed in the source
statements.
There has been a change in the ‑‑min‑conditional‑indent option. Instead of using number
of spaces to indent it now uses a code expressed in number of indents. In the past this option was a problem because
it was also affected by changes in indent length. With this release there is only one variable affected. The option
is not affected by changes in indent length. The minimum conditional indent length is computed automatically by
ASFormatter after all the options have been processed. Refer to the code in astyle_main.cpp to see how the option
is processed.
The --style=linux has been changed to ALWAYS use a minimum conditional indent of one-half the indent length. The
option is set in the function fixOptionVariableConflicts.
The use of locales affects only the command line build.
Previous releases are available in the News Archives .
astyle/doc/notes.html 100777 0 0 56762 12235007664 10326 0
Artistic Style - Release Notes
Artistic Style Release Notes
Artistic Style 2.04 (November 2013)
Add new programming language Objective‑C.
Add new bracket style option "style=google" (-A14).
Add new option "indent-preproc-cond" (xw) to indent preprocessor conditional statements (#118).
Add new bracket modify options "attach-namespaces", "attach-classes", "attach-inlines", and "attach-extern-c".
Add new option "indent-modifiers" (-xG) to indent class access modifiers one-half indent (#130).
Add new option "remove-brackets" (-xj) to remove brackets from single line conditional statements.
Add new option "remove-comment-prefix" (-xp) to remove the leading '*' from multi-line comments.
Add new option "align-method-colon" (-xM) to align Objective‑C method colons.
Add new option "pad-method-colon=#" (-xP#) to space pad Objective‑C method colons.
Add new options "pad-method-prefix" (-xQ), and "unpad-method-prefix" (-xR) to pad the Objective‑C "-" and
"+" method prefix.
Add new dll entry point AStyleMainUtf16 for processing C# UTF-16 strings.
Add formatting of C++11 raw string literals (#222).
Add "style=knf" as an alternative to "style=linux".
Remove depreciated "bracket=" options.
Improve recognition and formatting of pointers and references (#174 and other changes).
Improve the recognition of block-opening brackets.
Improve code using a static code analyzer (#195).
Change "max-code-length" to include Objective‑C methods.
Change "indent-elseifs" and "break-blocks" to look ahead only if in command-type brackets (speed improvement).
Fix linux bracket styles to break the opening bracket in inline function definitions (#185).
Fix indentation of switch block comments (#164).
Fix enums to indent with tabs when requested (#92, #121).
Fix formatting of rvalue reference without a name in a declaration (#219).
Fix "pad-first-paren-out" to not pad if the following parens are empty (#232).
Fix end-of-statement reset when comments follow closing bracket.
Fix the ASBeautifier active and waiting stacks to delete the ASBeautifier objects before deleting the pointers.
Fix ASBeautifier "init" to delete the tempStack vectors before deleting the tempStack.
Fix Linux piping problem by changing "cin" input to build a stringstream before formatting.
Fix to identify the correct bracket type when 'extern "C"' is part of the enum definition.
Fix to clear 'extern "C"' variables when the block is closed.
Fix unindented 'extern "C"' to not indent when in a #else preprocessor directive.
Fix not always correctly formatting linux type brackets for enum blocks.
Fix align-pointer in a range-based for statement (#217).
Fix pointer-reference argument alignment to correctly position a following comment (#235).
Fix to not attach a bracket to a line ending in a backslash '\' (#186, #214, #220).
Fix to recognize templates using multiple lines (#85, #87, #136).
Fix formatting of template continuation lines (#85, #87, #136).
Fix to allow '^' as an array operator (#233).
Fix an "enum" argument being mistaken for an enumeration (#211).
Fix to recognize a non-instatement array after a "},{" sequence.
Fix "pad-oper" to not pad before a following comma.
Fix recognition of an operator when the calculation contains a bitwise "not" '~' (#166).
Fix to allow a preprocessor statement within a preprocessor define (#238).
Fix preprocessor comparison to check for whole words (#246).
Fix "add-brackets" when a line contains more than one paren pairs (#181).
Fix to allow Mac old CR line endings in the options file (#129).
Refactor to aid debugging and improve design and decomposition:
Move ALL preliminary indentation calculations to computePreliminaryIndentation() in ASBeautifier.
Move calculation of 'force tab' indents to preLineWS() in ASBeautifier.
Combine methods init() and init(ASSourceIterator*) in ASBeautifier.
Extract method adjustParsedLineIndentation() in ASBeautifier.
Extract method parseCurrentLine() in ASEnhancer.
Remove astyle_main.cpp unused functions getFilesUnchanged, getOptionsFileRequired, and setOptionsFileRequired.
Artistic Style 2.03 (April 2013)
Add new option "indent=force-tab-x=#" (-xT#) to allow a tab length that different from the indent length (3430662).
Add new option, "pad-first-paren-out" (xd), to pad only the first paren in a series on the outside (3350356).
Add new option "max-code-length=#" (-xC#) to limit the length of code on a line.
Add new option "break-after-logical" (-xL) to modify a "max-code-length" line break for conditionals.
Add new option "close-templates" (-xy) to close whitespace in the angle brackets ">" of template
definitions.
Add formatting of C++ rvalue references (&&) using the existing "align-pointer" and "align-reference"
options.
Add formatting of C++/CLI managed pointers (the "^" character) to the "align-pointer" option.
Add translations for Dutch, Finnish, Italian, Japanese, Korean, Polish, Portuguese, Russian, Swedish, and Ukrainian.
Remove byte-order-mark from ASLocalizer.cpp.
Change the short option for delete-empty-lines from "xd" to "xe".
Change the ASTYLE_LIB option to remove __declspec for a Visual C static library when ASTYLE_NO_VCX is also declared.
Change to remove any space padding in a pointer to pointer (**).
Fix "break-elseifs" to format one-line "if" and "else" statements the same as when the option is not used.
Fix "break-elseifs" to break else-if statements when "keep-one-line-statements" also is requested.
Fix "break-elseifs" to correctly format comments preceding the else-if.
Fix C# not correctly identifying lambda expressions as a command-type bracket.
Fix C# preprocessor statements adding extra empty lines when "break-blocks" is used.
Fix C# padding "get" and "set" statements that are not headers when "break-blocks" is used.
Fix C# to recognize the "#line" statement.
Fix C++11 standard for range-based "for" loops (3458402, 3480095).
Fix C++11 standard for "enum" with a base type (3458402).
Fix C++11 standard for template closing angle brackets (no space required) (3495192).
Fix C/C++ keyword 'extern "C"' in a preprocessor causing an extra indent (1514844, 2953388, 2963382, 3093842,
3467479) .
Fix breaking after a switch "default" statement when "break-elseifs" is used without "keep-one-line-statements"
(3559365 ).
Fix in-statement arrays to indent correctly when they exceed the "max-instatement-indent".
Fix quote continuation sometimes being processed as a preprocessor directive (3445475).
Fix formatting of some conditional statements on a continuation-line.
Fix Java formatting of generics with wildcards (3428140).
Fix formatting of pointers and references to work with the new "max-code-length" option.
Fix formatting of pointers and references after a template close.
Fix formatting of empty attached brackets (3505002).
Fix C comments beginning a line breaking if they follow a semi-colon (3502700).
Fix "pad-header" not padding "return" and "throw" statements (3509134).
Fix recognition problems with templates.
Fix "struct" return type being mistaken for a struct.
Fix "pad-oper" in java for-each loop.
Fix recognition of a macro multi-line comment (3414970).
Fix bracketTypeStack entries added by #if and #else if the # is separated from the word.
Fix C++ breaking a line on an access modifier in a one-line block when "keep-one-line-blocks" is used.
Fix memory leak when "ascii" option is used.
Fix memory leak when a preprocessor statement is used without a closing #endif.
Fix preprocessor directive to allow compiling with mingw-x64 compiler.
Fix redirection on Windows so it does not hang when Linux line ends are used (3514712).
Fix redirection on Linux to output the correct line ends (3514712).
Fix non-portable return value on locale name (3452574).
Fix assert errors caused by not checking the text length on the return from peekNextText().
Fix spelling of "depreciated" in help message (3454735).
Refactor to improve design and decomposition:
Fix warning messages from Visual Studio static code analysis.
Fix warning messages from cppcheck, except for constructor uninitialized variables (false positive).
Remove astyle_main.h dependency from ASLocalizer.h
Remove appendChar() from the inline functions.
Extract methods for pointer or reference alignment in ASFormatter.
Artistic Style 2.02.1 (November 2011)
Add to C# the recognition of pointers and address-of operators.
Improve recognition of pointers and references (3,314,499, 3,298,204, and 2,990,608).
Improve alignment of a reference to a pointer (*&).
Fix crash with "align-pointer=type" when pointer to pointer (**) starts a new line (3,431,431).
Fix breaking after a "case" statement when "break-elseifs" is used without "keep-one-line-statements" (3,421,577,
and 3,314,247).
Fix "pad-oper" used with "keep-one-line-statements" not padding operators in a one-line "case" statement.
Fix not recognizing a "pointer dereference" or "address of" that follows a comment (3,431,431).
Fix "break-blocks" used with "delete-empty-lines" not correctly breaking blocks on the first run.
Fix "pad-oper" not padding the alternate comparison operators "and" and "or" (3,342,373).
Artistic Style 2.02 (May 2011)
Add new program module, ASLocalizer, containing language translations.
Add new short option prefix "x" to allow for expansion of short options.
Add new command line only option "ascii" (-I).
Add new bracket style, "style=pico" (-A11).
Add new bracket style, "style=lisp" (-A12).
Add new option "align-reference=" (-W#) (3,136,744).
Add new options ignore-exclude-errors (-i) and ignore-exclude-errors-x (-xi) (3,259,910).
Add new option "style=break" for Allman style brackets.
Add new option "style=attach" for Java style brackets.
Add processing of UTF-16 files by converting to UTF-8 and back to UTF-16.
Add Microsoft C++ extensions for try-finally and try-except statements (3,222,216).
Add "override" and "sealed" modifiers (Visual C specific) to preCommandHeaders vector (3,167,978).
Add "case" and "default" to the list of formatters in ASFormatter (3,276,212).
Remove "indent-brackets" and "indent-blocks" from the valid options.
Remove "volatile" from headers and remove comparisons in ASBeautifier.
Change "delete-empty-lines" short option from "x" to "xd".
Change "max-instatement-indent" maximum value from 80 to 120 (3,255,930).
Change "brackets=horstman" to "brackets=run-in", used for both Horstmann and Pico styles.
Change C enumerations to allow in-statement indents (3,280,454).
Change functions setting the "indent-brackets" and "indent-blocks" variables from public to protected.
Change to indent lines beginning with an assignment operator (3,292,880).
Change to abort if UTF-32 files are detected.
Change "Cannot set native locale" error message from cout to cerr (3,139,873).
Fix Linux infinite loop when a directory name is entered instead of a file name.
Fix trying to process directories as files when a wildcard is used without recursive (3,134,108).
Fix processing a "const" variable as a "const" method when it follows a header (3,168,156).
Fix indentation of a one-line block that follows a header.
Fix breaking a preprocessor define that has code after a comment end (3,132,531).
Fix "pad-oper" padding a dereference that follows a C-style cast (3,259,713).
Fix "unpad-parens" not recognizing an xor (^) operator (3,285,639).
Fix "break-blocks" procedure for "case" and "default" headers.
Fix "add-brackets" adding brackets to the "while" of a "do-while" loop (3,267,880).
Fix "add-brackets" adding brackets to an empty statement.
Fix "pad-paren" used with "align-pointer=name" incorrectly adding an extra space.
Fix not clearing a flag when a "?" conditional is included in an "if" statement (2,989,638).
Fix incorrect indentation when "volatile" modifier is used (3,279,856 ).
Fix indentation for Microsoft "#pragma region" and "#pragma endregion" preprocessor directives.
Fix not printing a zero for formatted numbers.
Fix indentation of a class opening bracket followed by a class modifier on the same line when indent-namespaces
and indent-classes are used.
Refactor to aid debugging, improve speed, and improve the design and decomposition:
Extract method processProcessor() from beautify() in ASBeautifier.
Extract method computePreliminaryIndentation() from beautify() in ASBeautifier.
Extract method parseCurrentLine() from beautify() in ASBeautifier.
Remove unnecessary copies to outBuffer variable in ASBeautifier.
Add preCommandHeaders vector to ASBeautifier and remove the "const" modifier comparisons.
Change static vectors to member variables.
Add isDigit() function to avoid the assert statements in Visual C.
Artistic Style 2.01 (November 2010)
Add recognition of language characters supported by the native locale.
Add formatting of numbers according to the native locale.
Add checksum verification to source file output.
Add formatting of MFC macros BEGIN_DISPATCH_MAP, BEGIN_EVENT_MAP, and BEGIN_PROPPAGEIDS.
Add error message if --recursive is used without a wildcard in the file name.
Add private (unusable) copy constructors for classes with dynamic allocation.
Add error message if the "cin" stream cannot be processed because a pipe is used.
Improve recognition of ARRAY_TYPE brackets.
Improve formatting of multi-line comments when the number of leading spaces must be changed.
Improve formatting of embedded SQL when the number of leading spaces must be changed.
Improve recognition of C++ templates.
Change --style=linux to always use a minimum conditional indent of one-half the indent length.
Change --pad-oper to pad operators in block parens.
Change to indent OpenMP pragmas with the code.
Change to display all (instead of one) option errors before abort.
Change the second argument of the fpError typedef from "char*" to "const char*".
Change Linux Makefiles to allow external values for CFLAGS and LDFLAGS.
Change all destructors to virtual.
Fix crash when --break-blocks is used and there is no closing bracket.
Fix deleting the previous line when a closing bracket follows a comment close.
Fix not recognizing text in quotes when identifying struct access modifiers.
Fix not popping the paren stack when a bracket precedes an end of line comment.
Fix not breaking a closing bracket when empty parens are enclosed in a single line block.
Fix indenting of C# anonymous statement closing bracket.
Fix recognition of C# non in-statement arrays.
Fix breaking single line blocks for C# abstract methods.
Fix not always clearing isNonInStatementArray flag.
Fix indenting "case" statements in a preprocessor definition when --indent-preprocessor is not requested.
Fix not recognizing the "volatile" type qualifier as a keyword.
Fix class initializers not being recognized as an in-statement indent.
Fix indenting Java abstract methods when "new" starts the line and brackets are broken.
Fix broken initializer lines (ending with comma) when there is more than one space after the type.
Fix --brackets=attach inserting a bracket inside comments following a preprocessor statement.
Fix --brackets=attach attaching an array bracket from a one line block to the previous line.
Fix --brackets=horstmann not breaking a comment line when the comment ends the line with a bracket.
Fix --pad-oper to recognize all * and & operators within a function call.
Fix --unpad-paren to recognize * and & operators within a function call.
Fix --pad-paren used with --delete-empty-lines causing a space to be added at end of line in some cases.
Fix --pad-paren padding a closing paren followed by a block paren.
Fix --add-brackets when a header is followed by a semi-colon.
Fix --align-pointer to pad or unpad pointers followed by parens or comments.
Fix --align-pointer to pad or unpad pointers following a scope resolution operator.
Fix --align-pointer to pad or unpad pointers that end the line.
Fix --align-pointer used with --pad-parens-out causing a space to be padded for each run.
Fix --break-blocks used with --delete-empty-lines causing an assert error when end of file is reached.
Fix --break-blocks used with --delete-empty-lines causing an assert error for some combinations of comment lines.
Fix --break-blocks used with --delete-empty-lines causing a duplicate line in some cases.
Fix --break-blocks used with --delete-empty-lines not always breaking opening blocks.
Fix --break-blocks used with --delete-empty-lines not always deleting empty lines for closing blocks.
Fix --break-blocks used with --fill-empty-lines not always correctly filling empty lines in a switch statement.
Fix --unpad-paren used with --pad-paren-in not padding between opening parens when multiple parens are used.
Fix --pad-oper incorrectly padding a template with a default parameter.
Fix ASBeautifier findOperator() method to recognize a C# lambda (=>) operator.
Fix ASFormatter nextLine() method to output an entire operator instead of individual characters.
Fix incorrectly identifying "*" as pointers in block parens.
Fix MinGW -Wshadow warnings.
Fix VS2010 "string subscript out of range" asserts.
Refactor:
Remove template definition for parseOptions() by using a vector reference instead of iterators as function arguments.
New ASOptions class to encapsulate global functions used by both the console and library builds.
Replace argc and argv in processOptions() with a vector to simplify test cases.
Replace IS_OPTION and IS_OPTIONS macros with ASOptions methods.
Replace GET_PARAM and GET_PARAMS macros with ASOptions methods.
Extract ASFormatter methods checkIfTemplateOpener() and isClosingHeader().
Previous releases are available in the Release Notes Archives .
astyle/doc/scripts.html 100777 0 0 14273 12235007664 10654 0
Artistic Style - Scripts
Artistic Style Scripts
The following are scripts to support the Artistic Style program. They are in various computer languages for multiple
platforms.
Scripts
astyle-clean.py is a Python script to clean a directory tree by
moving Artistic Style backup files to a separate directory. This allows Artistic Style to create backup files
without cluttering your source directories. There are four variables at the start of the script that need to be
set for each application. The script will move or copy backup files to a backup directory maintaining the original
directory structure. New backup files will be copied over the old so you will always have the most current backup.
astyle-clean.sh is a Linux shell script to clean a directory tree
by moving Artistic Style backup files to a separate directory. This allows Artistic Style to create backup files
without cluttering your source directories. There are four variables at the start of the script that need to be
set for each application. The script will move or copy backup files to a backup directory maintaining the original
directory structure. New backup files will be copied over the old so you will always have the most current backup.
astyle-clean.bat is a Windows batch file to clean a directory
tree by moving Artistic Style backup files to a separate directory. This allows Artistic Style to create backup
files without cluttering your source directories. There are four variables at the start of the script that need
to be set for each application. The script will move or copy backup files to a backup directory maintaining the
original directory structure. New backup files will be copied over the old so you will always have the most current
backup.
astyle.pl is a Mac Perl script to indent source files in TextWrangler
and BBEdit using Artistic Style. Selected text from the editor can be passed to Artistic Style and replaced with
the reformatted text. Save the script in the "Unix Filters" directory (you need to restart TextWrangler to see
new scripts). Then simply highlight the text you would like to indent, choose the script from the Shebang (#!
)
menu, and the text will be immaculately formatted. You can add Artistic Style options to the "my $astyle" line
in the script.
indent-commit.pl is a Perl script to integrate Artistic Style
with a CVS repository check-in. Before code is checked in, Artistic Style is automatically called so that the
repository files have a consistent style. This script was posted on the web site several years ago and probably
needs to be updated.
astyle-hooks.el is an Emacs Lisp script containing hooks to convert
Emacs default styles to Artistic Style default styles. There are hooks for C++, Java, and C# files. The C# hook
requires the csharp-mode.el file from
csharpmode on Google Project Hosting. For best results Artistic Style should use the options ‑‑min‑conditional‑indent=0
(‑m0) and ‑‑max‑instatement‑indent=50 (‑M50). Emacs does not seem to have
an option equivalent to these. The formatting for Emacs and Artistic Style will not be identical but should be
reasonably close.
astyle/doc/styles.css 100777 0 0 3453 12235007664 10312 0
/* h1 is a title
* h2 is a subtitle
* h3 is a hanging text title
* h4 is a non-hanging text title
* p.noindent is non-hanging text (text without a title)
* div.code is a light-blue backgroung color for preformatted code
* pre is preformatted source code
* p.contents entries are for the table of contents
* a.contents are table of contents links (not underlined)
* a.links are links (underlined)
* .footer is the image table at the bottom of the page
* img does not have a border
*/
body { background-color:white; margin-top:0.5in; margin-right:0.8in; margin-bottom:0.5in; margin-left:1.3in; }
h1 { color:#0000A0; text-align:center; font-style:italic; margin-top:18pt; margin-left:-0.5in; }
h2.large { color:#0000A0; text-align:center; font-size:x-large; margin-top:0.4in; margin-left:-0.5in; }
h2 { color:#0000A0; text-align:center; font-size:larger; margin-top:0.4in; margin-left:-0.5in; }
h3 { color:#0000A0; margin-top:0.4in; margin-left:-0.4in; }
h4 { color:#0000A0; }
p.noindent { margin-left:-0.4in; }
div.code { background:#E0E8FF; }
pre { margin-left:0.3in; }
/* pre.em { background:#FDFCFF; margin-right:0.3in;} */
p.contents1 { font-size:105%; margin-top:0in; margin-left:0in; margin-bottom:0in; margin-right:0in; }
p.contents2 { margin-top:0in; margin-left:.4in; margin-bottom:0in; margin-right:.4in; }
/* p.contents3 { margin-top:0in; margin-left:.8in; margin-bottom:0in; margin-right:.8in; } */
a.contents:link, a.contents:visited { color:#0000A0; text-decoration:none; }
a.contents:hover { color:#F00000; text-decoration:none; }
a:link, a:visited { color:#0000A0; text-decoration:underline; }
a:hover { color:#F00000; text-decoration:underline; }
center.footer { margin-left:-0.4in; margin-top:0.25in; }
h2.footer { font-size:x-large; margin-top:0; margin-left:0; }
img { border:none; }
astyle/doc/subversion.html 100777 0 0 13371 12235007664 11362 0
Artistic Style - Subversion
Artistic Style Subversion Repository
Artistic Style
The latest development source is in the Artistic Style repository at SourceForge. It can be checked out using
Subversion. The source code is under development and some changes take several weeks to complete. The intermediate
source files have not been through the extensive system tests that are done before each release. Use reasonable
precautions when using source code from the repository.
The repository address was changed on 5/31/13 when the project was upgraded to the Allura platform by SourceForge.
The new repository address is "https://svn.code.sf.net/p/astyle/code" or "svn://svn.code.sf.net/p/astyle/code".
The OLD repository address was "https://astyle.svn.sourceforge.net/svnroot/astyle", which is now read only. If
you have checked out a working copy of the AStyle source check the
Repository Upgrade FAQ for information on
how to change the repository .
The current version is in the "trunk/AStyle" branch of the repository. The file and directory names are case sensitive.
A sample checkout is:
svn checkout "https://svn.code.sf.net/p/astyle/code/trunk/AStyle" "$HOME/astyle"
You can also browse the subversion repository .
The current development release is in the "trunk" directory. This gives you a view into the current status of
the project's code without actually checking-out the files.
Other Projects
Two additional Artistic Style projects are available in the repository. They are not maintained for the general
public but are available if you want them. You may have to create your own project files and scripts to use them.
These projects require the Artistic Style project above. They are an extension that requires the Artistic Style
source. All projects, and any additional source required, should be installed in the same top level folder.
AStyleDev
AStyleDev contains the development files that are made available in the "Developer Information" section. Refer
to that section for more information.
A sample checkout is:
svn checkout "https://svn.code.sf.net/p/astyle/code/trunk/AStyleDev" "$HOME/astyledev"
AStyleTest
AStyleTest contains the unit test programs and test scripts for Artistic Style. There are over 2000 tests in the
main test program.
A sample checkout is:
svn checkout "https://svn.code.sf.net/p/astyle/code/trunk/AStyleTest" "$HOME/astyletest"
In addition to the Artistic Style source the test program requires
Google Mock . This is the Google multi-platform framework for writing C++
unit tests. The main Artistic Style test project, AStyleTest, actually uses "integration" tests instead of
"unit" tests. This type of testing can be effective for programs that were written without unit tests to begin
with.
An optional leak finder program can be added if you
are using Visual Studio. The Visual Leak Detector should be installed in the default install directory
(C:\Program Files (x86)\Visual Leak Detector). You do NOT need to change the "PATH" environment variable.
It can be downloaded from the website or installed from standard versions of Visual Studio 2012 from the
"Tools > Extensions and Updates" menu.
astyle/doc/vsinstall.html 100777 0 0 12526 12235007664 11203 0
.NET Framework SDK
Visual Studio 2010 C++ Express
Install Instructions for .NET Framework SDK
Following are instructions for installing the .NET Framework SDK in Visual Studio 2010 Express and adding x64
platforms to an existing project in a manner similar to the more expensive Visual Studio editions.
IMPORTANT: If Visual Studio 2010 Service Pack 1 is applied after the .NET Framework SDK install, an additional
update is
required to restore the Visual C++ compilers and libraries that may have been removed. Information is available
here .
Installing .NET Framework SDK
64-bit tools are not available on the Visual Studio 2010 C++ Express Edition by default. To enable 64-bit targets,
install the .NET Framework SDK in addition to the Visual Studio 2010 Express Edition. Otherwise, the x64 solution
platform is not available and a warning will occur if you open a project containing a 64-bit target.
Install the Windows SDK appropriate for your
operating system . Use the "Install Now" link to get the SDK. You can optionally
install the Windows Performance Toolkit, Debugging Tools, and Application Verifier. The Help is also optional.
After installing this package the x64 configurations can be created.
Adding x64 to Project Files
Open a Win32 project. Open the Configuration Manager from the Build menu. In the Active Solution Platform select
New. For the New Platform select x64. Usually you will want to “Copy settings from Win32” and check
“Create new project platforms”.
Open the Properties from the Project menu. There is a new configuration property that needs to be set for the
linker to find the system libraries. Be sure the x64 platform is selected and change "Configuration Properties
> General
> Platform Toolset" , to Windows7.1SDK . Otherwise you will get linker errors
such as "LINK : fatal error LNK1104: cannot open file 'kernel32.lib'". This setting can also optionally be used
for the Win32 platform.
The x64 configuration can now be compiled, but the compiles will place the files in the same directories as the
Win32 compiles. To correct this the x64 compiles should be placed in an x64 directory using the $(PlatformName)
macro.
Add the $(PlatformName) macro to “Configuration Properties > General > Output directory” so the
entry becomes $(SolutionDir)$(PlatformName)\ $(Configuration)\.
Add the $(PlatformName) macro to “Configuration Properties > General> Intermediate Directory”
so the entry becomes $(PlatformName)\ $(Configuration)\.
Check the x64 Debug configuration “Configuration Properties > Linker > Debugging > Generate Program Database File”
for $(ProjectDir)$(PlatformName)\ $(ConfigurationName)\$(TargetName).pdb.
Compile the project. If there are compile errors you may need to add the $(PlatformName) macro
to other settings as well. For example, if there are user library files the macro may need to be added to
“Configuration Properties > Linker > General > Additional Library Directories”.
You should now be able to compile both Win32 and x64 platforms in a manner similar to the more expensive Visual
Studio editions.
astyle/src/ 40777 0 0 0 12235007664 6172 5 astyle/src/ASBeautifier.cpp 100777 0 0 271204 12235007664 11347 0 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* ASBeautifier.cpp
*
* Copyright (C) 2006-2013 by Jim Pattee
* Copyright (C) 1998-2002 by Tal Davidson
*
*
* This file is a part of Artistic Style - an indentation and
* reformatting tool for C, C++, C# and Java source files.
*
*
* Artistic Style is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Artistic Style is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Artistic Style. If not, see .
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*/
#include "astyle.h"
#include
namespace astyle {
// this must be global
int g_preprocessorCppExternCBracket;
/**
* ASBeautifier's constructor
* This constructor is called only once for each source file.
* The cloned ASBeautifier objects are created with the copy constructor.
*/
ASBeautifier::ASBeautifier()
{
g_preprocessorCppExternCBracket = 0;
waitingBeautifierStack = NULL;
activeBeautifierStack = NULL;
waitingBeautifierStackLengthStack = NULL;
activeBeautifierStackLengthStack = NULL;
headerStack = NULL;
tempStacks = NULL;
blockParenDepthStack = NULL;
blockStatementStack = NULL;
parenStatementStack = NULL;
bracketBlockStateStack = NULL;
inStatementIndentStack = NULL;
inStatementIndentStackSizeStack = NULL;
parenIndentStack = NULL;
preprocIndentStack = NULL;
sourceIterator = NULL;
isModeManuallySet = false;
shouldForceTabIndentation = false;
setSpaceIndentation(4);
setMinConditionalIndentOption(MINCOND_TWO);
setMaxInStatementIndentLength(40);
classInitializerIndents = 1;
tabLength = 0;
setClassIndent(false);
setModifierIndent(false);
setSwitchIndent(false);
setCaseIndent(false);
setBlockIndent(false);
setBracketIndent(false);
setNamespaceIndent(false);
setLabelIndent(false);
setEmptyLineFill(false);
setCStyle();
setPreprocDefineIndent(false);
setPreprocConditionalIndent(false);
setAlignMethodColon(false);
// initialize ASBeautifier member vectors
beautifierFileType = 9; // reset to an invalid type
headers = new vector;
nonParenHeaders = new vector;
assignmentOperators = new vector;
nonAssignmentOperators = new vector;
preBlockStatements = new vector;
preCommandHeaders = new vector;
indentableHeaders = new vector;
}
/**
* ASBeautifier's copy constructor
* Copy the vector objects to vectors in the new ASBeautifier
* object so the new object can be destroyed without deleting
* the vector objects in the copied vector.
* This is the reason a copy constructor is needed.
*
* Must explicitly call the base class copy constructor.
*/
ASBeautifier::ASBeautifier(const ASBeautifier &other) : ASBase(other)
{
// these don't need to copy the stack
waitingBeautifierStack = NULL;
activeBeautifierStack = NULL;
waitingBeautifierStackLengthStack = NULL;
activeBeautifierStackLengthStack = NULL;
// vector '=' operator performs a DEEP copy of all elements in the vector
headerStack = new vector;
*headerStack = *other.headerStack;
tempStacks = copyTempStacks(other);
blockParenDepthStack = new vector;
*blockParenDepthStack = *other.blockParenDepthStack;
blockStatementStack = new vector;
*blockStatementStack = *other.blockStatementStack;
parenStatementStack = new vector;
*parenStatementStack = *other.parenStatementStack;
bracketBlockStateStack = new vector;
*bracketBlockStateStack = *other.bracketBlockStateStack;
inStatementIndentStack = new vector;
*inStatementIndentStack = *other.inStatementIndentStack;
inStatementIndentStackSizeStack = new vector;
*inStatementIndentStackSizeStack = *other.inStatementIndentStackSizeStack;
parenIndentStack = new vector;
*parenIndentStack = *other.parenIndentStack;
preprocIndentStack = new vector >;
*preprocIndentStack = *other.preprocIndentStack;
// Copy the pointers to vectors.
// This is ok because the original ASBeautifier object
// is not deleted until end of job.
beautifierFileType = other.beautifierFileType;
headers = other.headers;
nonParenHeaders = other.nonParenHeaders;
assignmentOperators = other.assignmentOperators;
nonAssignmentOperators = other.nonAssignmentOperators;
preBlockStatements = other.preBlockStatements;
preCommandHeaders = other.preCommandHeaders;
indentableHeaders = other.indentableHeaders;
// protected variables
// variables set by ASFormatter
// must also be updated in activeBeautifierStack
inLineNumber = other.inLineNumber;
horstmannIndentInStatement = other.horstmannIndentInStatement;
nonInStatementBracket = other.nonInStatementBracket;
lineCommentNoBeautify = other.lineCommentNoBeautify;
isElseHeaderIndent = other.isElseHeaderIndent;
isCaseHeaderCommentIndent = other.isCaseHeaderCommentIndent;
isNonInStatementArray = other.isNonInStatementArray;
isSharpAccessor = other.isSharpAccessor;
isSharpDelegate = other.isSharpDelegate;
isInExternC = other.isInExternC;
isInBeautifySQL = other.isInBeautifySQL;
isInIndentableStruct = other.isInIndentableStruct;
// private variables
sourceIterator = other.sourceIterator;
currentHeader = other.currentHeader;
previousLastLineHeader = other.previousLastLineHeader;
probationHeader = other.probationHeader;
lastLineHeader = other.lastLineHeader;
indentString = other.indentString;
verbatimDelimiter = other.verbatimDelimiter;
isInQuote = other.isInQuote;
isInVerbatimQuote = other.isInVerbatimQuote;
haveLineContinuationChar = other.haveLineContinuationChar;
isInAsm = other.isInAsm;
isInAsmOneLine = other.isInAsmOneLine;
isInAsmBlock = other.isInAsmBlock;
isInComment = other.isInComment;
isInPreprocessorComment = other.isInPreprocessorComment;
isInHorstmannComment = other.isInHorstmannComment;
isInCase = other.isInCase;
isInQuestion = other.isInQuestion;
isInStatement = other.isInStatement;
isInHeader = other.isInHeader;
isInTemplate = other.isInTemplate;
isInDefine = other.isInDefine;
isInDefineDefinition = other.isInDefineDefinition;
classIndent = other.classIndent;
isInClassInitializer = other.isInClassInitializer;
isInClassHeaderTab = other.isInClassHeaderTab;
isInObjCMethodDefinition = other.isInObjCMethodDefinition;
isImmediatelyPostObjCMethodDefinition = other.isImmediatelyPostObjCMethodDefinition;
isInObjCInterface = other.isInObjCInterface;
isInEnum = other.isInEnum;
modifierIndent = other.modifierIndent;
switchIndent = other.switchIndent;
caseIndent = other.caseIndent;
namespaceIndent = other.namespaceIndent;
bracketIndent = other.bracketIndent;
blockIndent = other.blockIndent;
labelIndent = other.labelIndent;
isInConditional = other.isInConditional;
isModeManuallySet = other.isModeManuallySet;
shouldForceTabIndentation = other.shouldForceTabIndentation;
emptyLineFill = other.emptyLineFill;
lineOpensWithLineComment = other.lineOpensWithLineComment;
lineOpensWithComment = other.lineOpensWithComment;
lineStartsInComment = other.lineStartsInComment;
backslashEndsPrevLine = other.backslashEndsPrevLine;
blockCommentNoIndent = other.blockCommentNoIndent;
blockCommentNoBeautify = other.blockCommentNoBeautify;
previousLineProbationTab = other.previousLineProbationTab;
lineBeginsWithOpenBracket = other.lineBeginsWithOpenBracket;
lineBeginsWithCloseBracket = other.lineBeginsWithCloseBracket;
shouldIndentBrackettedLine = other.shouldIndentBrackettedLine;
isInClass = other.isInClass;
isInSwitch = other.isInSwitch;
foundPreCommandHeader = other.foundPreCommandHeader;
foundPreCommandMacro = other.foundPreCommandMacro;
shouldAlignMethodColon = other.shouldAlignMethodColon;
shouldIndentPreprocDefine = other.shouldIndentPreprocDefine;
shouldIndentPreprocConditional = other.shouldIndentPreprocConditional;
indentCount = other.indentCount;
spaceIndentCount = other.spaceIndentCount;
spaceIndentObjCMethodDefinition = other.spaceIndentObjCMethodDefinition;
colonIndentObjCMethodDefinition = other.colonIndentObjCMethodDefinition;
lineOpeningBlocksNum = other.lineOpeningBlocksNum;
lineClosingBlocksNum = other.lineClosingBlocksNum;
fileType = other.fileType;
minConditionalOption = other.minConditionalOption;
minConditionalIndent = other.minConditionalIndent;
parenDepth = other.parenDepth;
indentLength = other.indentLength;
tabLength = other.tabLength;
blockTabCount = other.blockTabCount;
maxInStatementIndent = other.maxInStatementIndent;
classInitializerIndents = other.classInitializerIndents;
templateDepth = other.templateDepth;
squareBracketCount = other.squareBracketCount;
prevFinalLineSpaceIndentCount = other.prevFinalLineSpaceIndentCount;
prevFinalLineIndentCount = other.prevFinalLineIndentCount;
defineIndentCount = other.defineIndentCount;
quoteChar = other.quoteChar;
prevNonSpaceCh = other.prevNonSpaceCh;
currentNonSpaceCh = other.currentNonSpaceCh;
currentNonLegalCh = other.currentNonLegalCh;
prevNonLegalCh = other.prevNonLegalCh;
}
/**
* ASBeautifier's destructor
*/
ASBeautifier::~ASBeautifier()
{
deleteBeautifierContainer(waitingBeautifierStack);
deleteBeautifierContainer(activeBeautifierStack);
deleteContainer(waitingBeautifierStackLengthStack);
deleteContainer(activeBeautifierStackLengthStack);
deleteContainer(headerStack);
deleteTempStacksContainer(tempStacks);
deleteContainer(blockParenDepthStack);
deleteContainer(blockStatementStack);
deleteContainer(parenStatementStack);
deleteContainer(bracketBlockStateStack);
deleteContainer(inStatementIndentStack);
deleteContainer(inStatementIndentStackSizeStack);
deleteContainer(parenIndentStack);
deleteContainer(preprocIndentStack);
}
/**
* initialize the ASBeautifier.
*
* This init() should be called every time a ABeautifier object is to start
* beautifying a NEW source file.
* It is called only when a new ASFormatter object is created.
* init() recieves a pointer to a ASSourceIterator object that will be
* used to iterate through the source code.
*
* @param iter a pointer to the ASSourceIterator or ASStreamIterator object.
*/
void ASBeautifier::init(ASSourceIterator* iter)
{
sourceIterator = iter;
initVectors();
ASBase::init(getFileType());
initContainer(waitingBeautifierStack, new vector);
initContainer(activeBeautifierStack, new vector);
initContainer(waitingBeautifierStackLengthStack, new vector);
initContainer(activeBeautifierStackLengthStack, new vector);
initContainer(headerStack, new vector);
initTempStacksContainer(tempStacks, new vector*>);
tempStacks->push_back(new vector);
initContainer(blockParenDepthStack, new vector);
initContainer(blockStatementStack, new vector);
initContainer(parenStatementStack, new vector);
initContainer(bracketBlockStateStack, new vector);
bracketBlockStateStack->push_back(true);
initContainer(inStatementIndentStack, new vector);
initContainer(inStatementIndentStackSizeStack, new vector);
inStatementIndentStackSizeStack->push_back(0);
initContainer(parenIndentStack, new vector);
initContainer(preprocIndentStack, new vector >);
previousLastLineHeader = NULL;
currentHeader = NULL;
isInQuote = false;
isInVerbatimQuote = false;
haveLineContinuationChar = false;
isInAsm = false;
isInAsmOneLine = false;
isInAsmBlock = false;
isInComment = false;
isInPreprocessorComment = false;
isInHorstmannComment = false;
isInStatement = false;
isInCase = false;
isInQuestion = false;
isInClassInitializer = false;
isInClassHeaderTab = false;
isInObjCMethodDefinition = false;
isImmediatelyPostObjCMethodDefinition = false;
isInObjCInterface = false;
isInEnum = false;
isInHeader = false;
isInTemplate = false;
isInConditional = false;
indentCount = 0;
spaceIndentCount = 0;
spaceIndentObjCMethodDefinition = 0;
colonIndentObjCMethodDefinition = 0;
lineOpeningBlocksNum = 0;
lineClosingBlocksNum = 0;
templateDepth = 0;
squareBracketCount = 0;
parenDepth = 0;
blockTabCount = 0;
prevFinalLineSpaceIndentCount = 0;
prevFinalLineIndentCount = 0;
defineIndentCount = 0;
prevNonSpaceCh = '{';
currentNonSpaceCh = '{';
prevNonLegalCh = '{';
currentNonLegalCh = '{';
quoteChar = ' ';
probationHeader = NULL;
lastLineHeader = NULL;
backslashEndsPrevLine = false;
lineOpensWithLineComment = false;
lineOpensWithComment = false;
lineStartsInComment = false;
isInDefine = false;
isInDefineDefinition = false;
lineCommentNoBeautify = false;
isElseHeaderIndent = false;
isCaseHeaderCommentIndent = false;
blockCommentNoIndent = false;
blockCommentNoBeautify = false;
previousLineProbationTab = false;
lineBeginsWithOpenBracket = false;
lineBeginsWithCloseBracket = false;
shouldIndentBrackettedLine = true;
isInClass = false;
isInSwitch = false;
foundPreCommandHeader = false;
foundPreCommandMacro = false;
isNonInStatementArray = false;
isSharpAccessor = false;
isSharpDelegate = false;
isInExternC = false;
isInBeautifySQL = false;
isInIndentableStruct = false;
inLineNumber = 0;
horstmannIndentInStatement = 0;
nonInStatementBracket = 0;
}
/*
* initialize the vectors
*/
void ASBeautifier::initVectors()
{
if (fileType == beautifierFileType) // don't build unless necessary
return;
beautifierFileType = fileType;
headers->clear();
nonParenHeaders->clear();
assignmentOperators->clear();
nonAssignmentOperators->clear();
preBlockStatements->clear();
preCommandHeaders->clear();
indentableHeaders->clear();
ASResource::buildHeaders(headers, fileType, true);
ASResource::buildNonParenHeaders(nonParenHeaders, fileType, true);
ASResource::buildAssignmentOperators(assignmentOperators);
ASResource::buildNonAssignmentOperators(nonAssignmentOperators);
ASResource::buildPreBlockStatements(preBlockStatements, fileType);
ASResource::buildPreCommandHeaders(preCommandHeaders, fileType);
ASResource::buildIndentableHeaders(indentableHeaders);
}
/**
* set indentation style to C/C++.
*/
void ASBeautifier::setCStyle()
{
fileType = C_TYPE;
}
/**
* set indentation style to Java.
*/
void ASBeautifier::setJavaStyle()
{
fileType = JAVA_TYPE;
}
/**
* set indentation style to C#.
*/
void ASBeautifier::setSharpStyle()
{
fileType = SHARP_TYPE;
}
/**
* set mode manually set flag
*/
void ASBeautifier::setModeManuallySet(bool state)
{
isModeManuallySet = state;
}
/**
* set tabLength equal to indentLength.
* This is done when tabLength is not explicitely set by
* "indent=force-tab-x"
*
*/
void ASBeautifier::setDefaultTabLength()
{
tabLength = indentLength;
}
/**
* indent using a different tab setting for indent=force-tab
*
* @param length number of spaces per tab.
*/
void ASBeautifier::setForceTabXIndentation(int length)
{
// set tabLength instead of indentLength
indentString = "\t";
tabLength = length;
shouldForceTabIndentation = true;
}
/**
* indent using one tab per indentation
*/
void ASBeautifier::setTabIndentation(int length, bool forceTabs)
{
indentString = "\t";
indentLength = length;
shouldForceTabIndentation = forceTabs;
}
/**
* indent using a number of spaces per indentation.
*
* @param length number of spaces per indent.
*/
void ASBeautifier::setSpaceIndentation(int length)
{
indentString = string(length, ' ');
indentLength = length;
}
/**
* set the maximum indentation between two lines in a multi-line statement.
*
* @param max maximum indentation length.
*/
void ASBeautifier::setMaxInStatementIndentLength(int max)
{
maxInStatementIndent = max;
}
/**
* set the minimum conditional indentation option.
*
* @param min minimal indentation option.
*/
void ASBeautifier::setMinConditionalIndentOption(int min)
{
minConditionalOption = min;
}
/**
* set minConditionalIndent from the minConditionalOption.
*/
void ASBeautifier::setMinConditionalIndentLength()
{
if (minConditionalOption == MINCOND_ZERO)
minConditionalIndent = 0;
else if (minConditionalOption == MINCOND_ONE)
minConditionalIndent = indentLength;
else if (minConditionalOption == MINCOND_ONEHALF)
minConditionalIndent = indentLength / 2;
// minConditionalOption = INDENT_TWO
else minConditionalIndent = indentLength * 2;
}
/**
* set the state of the bracket indentation option. If true, brackets will
* be indented one additional indent.
*
* @param state state of option.
*/
void ASBeautifier::setBracketIndent(bool state)
{
bracketIndent = state;
}
/**
* set the state of the block indentation option. If true, entire blocks
* will be indented one additional indent, similar to the GNU indent style.
*
* @param state state of option.
*/
void ASBeautifier::setBlockIndent(bool state)
{
blockIndent = state;
}
/**
* set the state of the class indentation option. If true, C++ class
* definitions will be indented one additional indent.
*
* @param state state of option.
*/
void ASBeautifier::setClassIndent(bool state)
{
classIndent = state;
}
/**
* set the state of the modifier indentation option. If true, C++ class
* access modifiers will be indented one-half an indent.
*
* @param state state of option.
*/
void ASBeautifier::setModifierIndent(bool state)
{
modifierIndent = state;
}
/**
* set the state of the switch indentation option. If true, blocks of 'switch'
* statements will be indented one additional indent.
*
* @param state state of option.
*/
void ASBeautifier::setSwitchIndent(bool state)
{
switchIndent = state;
}
/**
* set the state of the case indentation option. If true, lines of 'case'
* statements will be indented one additional indent.
*
* @param state state of option.
*/
void ASBeautifier::setCaseIndent(bool state)
{
caseIndent = state;
}
/**
* set the state of the namespace indentation option.
* If true, blocks of 'namespace' statements will be indented one
* additional indent. Otherwise, NO indentation will be added.
*
* @param state state of option.
*/
void ASBeautifier::setNamespaceIndent(bool state)
{
namespaceIndent = state;
}
/**
* set the state of the label indentation option.
* If true, labels will be indented one indent LESS than the
* current indentation level.
* If false, labels will be flushed to the left with NO
* indent at all.
*
* @param state state of option.
*/
void ASBeautifier::setLabelIndent(bool state)
{
labelIndent = state;
}
/**
* set the state of the preprocessor indentation option.
* If true, multiline #define statements will be indented.
*
* @param state state of option.
*/
void ASBeautifier::setPreprocDefineIndent(bool state)
{
shouldIndentPreprocDefine = state;
}
void ASBeautifier::setPreprocConditionalIndent(bool state)
{
shouldIndentPreprocConditional = state;
}
/**
* set the state of the empty line fill option.
* If true, empty lines will be filled with the whitespace.
* of their previous lines.
* If false, these lines will remain empty.
*
* @param state state of option.
*/
void ASBeautifier::setEmptyLineFill(bool state)
{
emptyLineFill = state;
}
void ASBeautifier::setAlignMethodColon(bool state)
{
shouldAlignMethodColon = state;
}
/**
* get the file type.
*/
int ASBeautifier::getFileType() const
{
return fileType;
}
/**
* get the number of spaces per indent
*
* @return value of indentLength option.
*/
int ASBeautifier::getIndentLength(void) const
{
return indentLength;
}
/**
* get the char used for indentation, space or tab
*
* @return the char used for indentation.
*/
string ASBeautifier::getIndentString(void) const
{
return indentString;
}
/**
* get mode manually set flag
*/
bool ASBeautifier::getModeManuallySet() const
{
return isModeManuallySet;
}
/**
* get the state of the force tab indentation option.
*
* @return state of force tab indentation.
*/
bool ASBeautifier::getForceTabIndentation(void) const
{
return shouldForceTabIndentation;
}
/**
* get the state of the block indentation option.
*
* @return state of blockIndent option.
*/
bool ASBeautifier::getBlockIndent(void) const
{
return blockIndent;
}
/**
* get the state of the bracket indentation option.
*
* @return state of bracketIndent option.
*/
bool ASBeautifier::getBracketIndent(void) const
{
return bracketIndent;
}
/**
* get the state of the class indentation option. If true, blocks of
* the 'class' statement will be indented one additional indent.
*
* @return state of classIndent option.
*/
bool ASBeautifier::getClassIndent(void) const
{
return classIndent;
}
/**
* get the state of the switch indentation option. If true, blocks of
* the 'switch' statement will be indented one additional indent.
*
* @return state of switchIndent option.
*/
bool ASBeautifier::getSwitchIndent(void) const
{
return switchIndent;
}
/**
* get the state of the case indentation option. If true, lines of 'case'
* statements will be indented one additional indent.
*
* @return state of caseIndent option.
*/
bool ASBeautifier::getCaseIndent(void) const
{
return caseIndent;
}
/**
* get the state of the empty line fill option.
* If true, empty lines will be filled with the whitespace.
* of their previous lines.
* If false, these lines will remain empty.
*
* @return state of emptyLineFill option.
*/
bool ASBeautifier::getEmptyLineFill(void) const
{
return emptyLineFill;
}
/**
* get the state of the preprocessor indentation option.
* If true, preprocessor "define" lines will be indented.
* If false, preprocessor "define" lines will be unchanged.
*
* @return state of shouldIndentPreprocDefine option.
*/
bool ASBeautifier::getPreprocDefineIndent(void) const
{
return shouldIndentPreprocDefine;
}
/**
* get the length of the tab indentation option.
*
* @return length of tab indent option.
*/
int ASBeautifier::getTabLength(void) const
{
return tabLength;
}
/**
* beautify a line of source code.
* every line of source code in a source code file should be sent
* one after the other to the beautify method.
*
* @return the indented line.
* @param originalLine the original unindented line.
*/
string ASBeautifier::beautify(const string &originalLine)
{
string line;
bool isInQuoteContinuation = isInVerbatimQuote | haveLineContinuationChar;
currentHeader = NULL;
lastLineHeader = NULL;
blockCommentNoBeautify = blockCommentNoIndent;
isInClass = false;
isInSwitch = false;
lineBeginsWithOpenBracket = false;
lineBeginsWithCloseBracket = false;
shouldIndentBrackettedLine = true;
isInAsmOneLine = false;
lineOpensWithLineComment = false;
lineOpensWithComment = false;
lineStartsInComment = isInComment;
previousLineProbationTab = false;
haveLineContinuationChar = false;
lineOpeningBlocksNum = 0;
lineClosingBlocksNum = 0;
if (isImmediatelyPostObjCMethodDefinition)
clearObjCMethodDefinitionAlignment();
// handle and remove white spaces around the line:
// If not in comment, first find out size of white space before line,
// so that possible comments starting in the line continue in
// relation to the preliminary white-space.
if (isInQuoteContinuation)
{
// trim a single space added by ASFormatter, otherwise leave it alone
if (!(originalLine.length() == 1 && originalLine[0] == ' '))
line = originalLine;
}
else if (isInComment || isInBeautifySQL)
{
// trim the end of comment and SQL lines
line = originalLine;
size_t trimEnd = line.find_last_not_of(" \t");
if (trimEnd == string::npos)
trimEnd = 0;
else
trimEnd++;
if (trimEnd < line.length())
line.erase(trimEnd);
// does a bracket open the line
size_t firstChar = line.find_first_not_of(" \t");
if (firstChar != string::npos)
{
if (line[firstChar] == '{')
lineBeginsWithOpenBracket = true;
else if (line[firstChar] == '}')
lineBeginsWithCloseBracket = true;
}
}
else
{
line = trim(originalLine);
if (line.length() > 0)
{
if (line[0] == '{')
lineBeginsWithOpenBracket = true;
else if (line[0] == '}')
lineBeginsWithCloseBracket = true;
}
isInHorstmannComment = false;
size_t j = line.find_first_not_of(" \t{");
if (j != string::npos && line.compare(j, 2, "//") == 0)
lineOpensWithLineComment = true;
if (j != string::npos && line.compare(j, 2, "/*") == 0)
{
lineOpensWithComment = true;
size_t k = line.find_first_not_of(" \t");
if (k != string::npos && line.compare(k, 1, "{") == 0)
isInHorstmannComment = true;
}
}
if (line.length() == 0)
{
if (backslashEndsPrevLine) // must continue to clear variables
line = ' ';
else if (emptyLineFill && !isInQuoteContinuation
&& (!headerStack->empty() || isInEnum))
return preLineWS(prevFinalLineIndentCount, prevFinalLineSpaceIndentCount);
else
return line;
}
// handle preprocessor commands
if (!isInComment
&& !isInQuoteContinuation
&& line.length() > 0
&& ((line[0] == '#' && !isIndentedPreprocessor(line, 0))
|| backslashEndsPrevLine))
{
if (line[0] == '#' && !isInDefine)
{
string preproc = extractPreprocessorStatement(line);
processPreprocessor(preproc, line);
if (shouldIndentPreprocConditional && preproc.length() > 0)
{
if (preproc.length() >= 2 && preproc.substr(0, 2) == "if")
{
pair entry;
if (!isInDefine && activeBeautifierStack != NULL && !activeBeautifierStack->empty())
entry = activeBeautifierStack->back()->computePreprocessorIndent();
else
entry = computePreprocessorIndent();
preprocIndentStack->push_back(entry);
return preLineWS(preprocIndentStack->back().first,
preprocIndentStack->back().second) + line;
}
else if (preproc == "else" || preproc == "elif")
{
if (preprocIndentStack->size() > 0) // if no entry don't indent
return preLineWS(preprocIndentStack->back().first,
preprocIndentStack->back().second) + line;
}
else if (preproc == "endif")
{
if (preprocIndentStack->size() > 0) // if no entry don't indent
{
string indentedLine = preLineWS(preprocIndentStack->back().first,
preprocIndentStack->back().second) + line;
preprocIndentStack->pop_back();
return indentedLine;
}
}
}
}
// check if the last char is a backslash
if (line.length() > 0)
backslashEndsPrevLine = (line[line.length() - 1] == '\\');
// comments within the definition line can be continued without the backslash
if (isInPreprocessorUnterminatedComment(line))
backslashEndsPrevLine = true;
// check if this line ends a multi-line #define
// if so, use the #define's cloned beautifier for the line's indentation
// and then remove it from the active beautifier stack and delete it.
if (!backslashEndsPrevLine && isInDefineDefinition && !isInDefine)
{
string beautifiedLine;
ASBeautifier* defineBeautifier;
isInDefineDefinition = false;
defineBeautifier = activeBeautifierStack->back();
activeBeautifierStack->pop_back();
beautifiedLine = defineBeautifier->beautify(line);
delete defineBeautifier;
return beautifiedLine;
}
// unless this is a multi-line #define, return this precompiler line as is.
if (!isInDefine && !isInDefineDefinition)
return originalLine;
}
// if there exists any worker beautifier in the activeBeautifierStack,
// then use it instead of me to indent the current line.
// variables set by ASFormatter must be updated.
if (!isInDefine && activeBeautifierStack != NULL && !activeBeautifierStack->empty())
{
activeBeautifierStack->back()->inLineNumber = inLineNumber;
activeBeautifierStack->back()->horstmannIndentInStatement = horstmannIndentInStatement;
activeBeautifierStack->back()->nonInStatementBracket = nonInStatementBracket;
activeBeautifierStack->back()->lineCommentNoBeautify = lineCommentNoBeautify;
activeBeautifierStack->back()->isElseHeaderIndent = isElseHeaderIndent;
activeBeautifierStack->back()->isCaseHeaderCommentIndent = isCaseHeaderCommentIndent;
activeBeautifierStack->back()->isNonInStatementArray = isNonInStatementArray;
activeBeautifierStack->back()->isSharpAccessor = isSharpAccessor;
activeBeautifierStack->back()->isSharpDelegate = isSharpDelegate;
activeBeautifierStack->back()->isInExternC = isInExternC;
activeBeautifierStack->back()->isInBeautifySQL = isInBeautifySQL;
activeBeautifierStack->back()->isInIndentableStruct = isInIndentableStruct;
// must return originalLine not the trimmed line
return activeBeautifierStack->back()->beautify(originalLine);
}
// Flag an indented header in case this line is a one-line block.
// The header in the header stack will be deleted by a one-line block.
bool isInExtraHeaderIndent = false;
if (!headerStack->empty()
&& lineBeginsWithOpenBracket
&& (headerStack->back() != &AS_OPEN_BRACKET
|| probationHeader != NULL))
isInExtraHeaderIndent = true;
size_t iPrelim = headerStack->size();
// calculate preliminary indentation based on headerStack and data from past lines
computePreliminaryIndentation();
// parse characters in the current line.
parseCurrentLine(line);
// handle special cases of indentation
adjustParsedLineIndentation(iPrelim, isInExtraHeaderIndent);
// Objective-C continuation line
if (isInObjCMethodDefinition)
{
// register indent for Objective-C continuation line
if (line.length() > 0
&& (line[0] == '-' || line[0] == '+'))
{
if (shouldAlignMethodColon)
{
colonIndentObjCMethodDefinition = line.find(':');
}
else if (inStatementIndentStack->empty()
|| inStatementIndentStack->back() == 0)
{
inStatementIndentStack->push_back(indentLength);
isInStatement = true;
}
}
// set indent for last definition line
else if (!lineBeginsWithOpenBracket)
{
if (shouldAlignMethodColon)
spaceIndentCount = computeObjCColonAlignment(line, colonIndentObjCMethodDefinition);
else if (inStatementIndentStack->empty())
spaceIndentCount = spaceIndentObjCMethodDefinition;
}
}
if (isInDefine)
{
if (line.length() > 0 && line[0] == '#')
{
// the 'define' does not have to be attached to the '#'
string preproc = trim(line.substr(1));
if (preproc.compare(0, 6, "define") == 0)
{
if (!inStatementIndentStack->empty()
&& inStatementIndentStack->back() > 0)
{
defineIndentCount = indentCount;
}
else
{
defineIndentCount = indentCount - 1;
--indentCount;
}
}
}
indentCount -= defineIndentCount;
}
if (indentCount < 0)
indentCount = 0;
if (lineCommentNoBeautify || blockCommentNoBeautify || isInQuoteContinuation)
indentCount = spaceIndentCount = 0;
// finally, insert indentations into begining of line
string outBuffer = preLineWS(indentCount, spaceIndentCount) + line;
prevFinalLineSpaceIndentCount = spaceIndentCount;
prevFinalLineIndentCount = indentCount;
if (lastLineHeader != NULL)
previousLastLineHeader = lastLineHeader;
return outBuffer;
}
string ASBeautifier::preLineWS(int lineIndentCount, int lineSpaceIndentCount) const
{
if (shouldForceTabIndentation)
{
if (tabLength != indentLength)
{
// adjust for different tab length
int indentCountOrig = lineIndentCount;
int spaceIndentCountOrig = lineSpaceIndentCount;
lineIndentCount = ((indentCountOrig * indentLength) + spaceIndentCountOrig) / tabLength;
lineSpaceIndentCount = ((indentCountOrig * indentLength) + spaceIndentCountOrig) % tabLength;
}
else
{
lineIndentCount += lineSpaceIndentCount / indentLength;
lineSpaceIndentCount = lineSpaceIndentCount % indentLength;
}
}
string ws;
for (int i = 0; i < lineIndentCount; i++)
ws += indentString;
while ((lineSpaceIndentCount--) > 0)
ws += string(" ");
return ws;
}
/**
* register an in-statement indent.
*/
void ASBeautifier::registerInStatementIndent(const string &line, int i, int spaceTabCount_,
int tabIncrementIn, int minIndent, bool updateParenStack)
{
int inStatementIndent;
int remainingCharNum = line.length() - i;
int nextNonWSChar = getNextProgramCharDistance(line, i);
// if indent is around the last char in the line, indent instead one indent from the previous indent
if (nextNonWSChar == remainingCharNum)
{
int previousIndent = spaceTabCount_;
if (!inStatementIndentStack->empty())
previousIndent = inStatementIndentStack->back();
int currIndent = /*2*/ indentLength + previousIndent;
if (currIndent > maxInStatementIndent
&& line[i] != '{')
currIndent = indentLength * 2 + spaceTabCount_;
inStatementIndentStack->push_back(currIndent);
if (updateParenStack)
parenIndentStack->push_back(previousIndent);
return;
}
if (updateParenStack)
parenIndentStack->push_back(i + spaceTabCount_ - horstmannIndentInStatement);
int tabIncrement = tabIncrementIn;
// check for following tabs
for (int j = i + 1; j < (i + nextNonWSChar); j++)
{
if (line[j] == '\t')
tabIncrement += convertTabToSpaces(j, tabIncrement);
}
inStatementIndent = i + nextNonWSChar + spaceTabCount_ + tabIncrement;
// check for run-in statement
if (i > 0 && line[0] == '{')
inStatementIndent -= indentLength;
if (inStatementIndent < minIndent)
inStatementIndent = minIndent + spaceTabCount_;
// this is not done for an in-statement array
if (inStatementIndent > maxInStatementIndent
&& !(prevNonLegalCh == '=' && currentNonLegalCh == '{'))
inStatementIndent = indentLength * 2 + spaceTabCount_;
if (!inStatementIndentStack->empty() &&
inStatementIndent < inStatementIndentStack->back())
inStatementIndent = inStatementIndentStack->back();
// the block opener is not indented for a NonInStatementArray
if (isNonInStatementArray && !isInEnum && !bracketBlockStateStack->empty() && bracketBlockStateStack->back())
inStatementIndent = 0;
inStatementIndentStack->push_back(inStatementIndent);
}
/**
* Compute indentation for a preprocessor #if statement.
* This may be called for the activeBeautiferStack
* instead of the active ASBeautifier object.
*/
pair ASBeautifier::computePreprocessorIndent()
{
computePreliminaryIndentation();
pair entry (indentCount, spaceIndentCount);
if (!headerStack->empty()
&& entry.first > 0
&& (headerStack->back() == &AS_IF
|| headerStack->back() == &AS_ELSE
|| headerStack->back() == &AS_FOR
|| headerStack->back() == &AS_WHILE))
--entry.first;
return entry;
}
/**
* get distance to the next non-white space, non-comment character in the line.
* if no such character exists, return the length remaining to the end of the line.
*/
int ASBeautifier::getNextProgramCharDistance(const string &line, int i) const
{
bool inComment = false;
int remainingCharNum = line.length() - i;
int charDistance;
char ch;
for (charDistance = 1; charDistance < remainingCharNum; charDistance++)
{
ch = line[i + charDistance];
if (inComment)
{
if (line.compare(i + charDistance, 2, "*/") == 0)
{
charDistance++;
inComment = false;
}
continue;
}
else if (isWhiteSpace(ch))
continue;
else if (ch == '/')
{
if (line.compare(i + charDistance, 2, "//") == 0)
return remainingCharNum;
else if (line.compare(i + charDistance, 2, "/*") == 0)
{
charDistance++;
inComment = true;
}
}
else
return charDistance;
}
return charDistance;
}
// check if a specific line position contains a header.
const string* ASBeautifier::findHeader(const string &line, int i,
const vector* possibleHeaders) const
{
assert(isCharPotentialHeader(line, i));
// check the word
size_t maxHeaders = possibleHeaders->size();
for (size_t p = 0; p < maxHeaders; p++)
{
const string* header = (*possibleHeaders)[p];
const size_t wordEnd = i + header->length();
if (wordEnd > line.length())
continue;
int result = (line.compare(i, header->length(), *header));
if (result > 0)
continue;
if (result < 0)
break;
// check that this is not part of a longer word
if (wordEnd == line.length())
return header;
if (isLegalNameChar(line[wordEnd]))
continue;
const char peekChar = peekNextChar(line, wordEnd - 1);
// is not a header if part of a definition
if (peekChar == ',' || peekChar == ')')
break;
// the following accessor definitions are NOT headers
// goto default; is NOT a header
// default(int) keyword in C# is NOT a header
else if ((header == &AS_GET || header == &AS_SET || header == &AS_DEFAULT)
&& (peekChar == ';' || peekChar == '(' || peekChar == '='))
break;
return header;
}
return NULL;
}
// check if a specific line position contains an operator.
const string* ASBeautifier::findOperator(const string &line, int i,
const vector* possibleOperators) const
{
assert(isCharPotentialOperator(line[i]));
// find the operator in the vector
// the vector contains the LONGEST operators first
// must loop thru the entire vector
size_t maxOperators = possibleOperators->size();
for (size_t p = 0; p < maxOperators; p++)
{
const size_t wordEnd = i + (*(*possibleOperators)[p]).length();
if (wordEnd > line.length())
continue;
if (line.compare(i, (*(*possibleOperators)[p]).length(), *(*possibleOperators)[p]) == 0)
return (*possibleOperators)[p];
}
return NULL;
}
/**
* find the index number of a string element in a container of strings
*
* @return the index number of element in the container. -1 if element not found.
* @param container a vector of strings.
* @param element the element to find .
*/
int ASBeautifier::indexOf(vector &container, const string* element) const
{
vector::const_iterator where;
where = find(container.begin(), container.end(), element);
if (where == container.end())
return -1;
else
return (int) (where - container.begin());
}
/**
* convert tabs to spaces.
* i is the position of the character to convert to spaces.
* tabIncrementIn is the increment that must be added for tab indent characters
* to get the correct column for the current tab.
*/
int ASBeautifier::convertTabToSpaces(int i, int tabIncrementIn) const
{
int tabToSpacesAdjustment = indentLength - 1 - ((tabIncrementIn + i) % indentLength);
return tabToSpacesAdjustment;
}
/**
* trim removes the white space surrounding a line.
*
* @return the trimmed line.
* @param str the line to trim.
*/
string ASBeautifier::trim(const string &str) const
{
int start = 0;
int end = str.length() - 1;
while (start < end && isWhiteSpace(str[start]))
start++;
while (start <= end && isWhiteSpace(str[end]))
end--;
// don't trim if it ends in a continuation
if (end > -1 && str[end] == '\\')
end = str.length() - 1;
string returnStr(str, start, end + 1 - start);
return returnStr;
}
/**
* rtrim removes the white space from the end of a line.
*
* @return the trimmed line.
* @param str the line to trim.
*/
string ASBeautifier::rtrim(const string &str) const
{
size_t len = str.length();
size_t end = str.find_last_not_of(" \t");
if (end == string::npos
|| end == len - 1)
return str;
string returnStr(str, 0, end + 1);
return returnStr;
}
/**
* Copy tempStacks for the copy constructor.
* The value of the vectors must also be copied.
*/
vector*>* ASBeautifier::copyTempStacks(const ASBeautifier &other) const
{
vector*>* tempStacksNew = new vector*>;
vector*>::iterator iter;
for (iter = other.tempStacks->begin();
iter != other.tempStacks->end();
++iter)
{
vector* newVec = new vector;
*newVec = **iter;
tempStacksNew->push_back(newVec);
}
return tempStacksNew;
}
/**
* delete a member vectors to eliminate memory leak reporting
*/
void ASBeautifier::deleteBeautifierVectors()
{
beautifierFileType = 9; // reset to an invalid type
delete headers;
delete nonParenHeaders;
delete preBlockStatements;
delete preCommandHeaders;
delete assignmentOperators;
delete nonAssignmentOperators;
delete indentableHeaders;
}
/**
* delete a vector object
* T is the type of vector
* used for all vectors except tempStacks
*/
template
void ASBeautifier::deleteContainer(T &container)
{
if (container != NULL)
{
container->clear();
delete (container);
container = NULL;
}
}
/**
* Delete the ASBeautifier vector object.
* This is a vector of pointers to ASBeautifier objects allocated with the 'new' operator.
* Therefore the ASBeautifier objects have to be deleted in addition to the
* ASBeautifier pointer entries.
*/
void ASBeautifier::deleteBeautifierContainer(vector* &container)
{
if (container != NULL)
{
vector::iterator iter = container->begin();
while (iter < container->end())
{
delete *iter;
++iter;
}
container->clear();
delete (container);
container = NULL;
}
}
/**
* Delete the tempStacks vector object.
* The tempStacks is a vector of pointers to strings allocated with the 'new' operator.
* Therefore the strings have to be deleted in addition to the tempStacks entries.
*/
void ASBeautifier::deleteTempStacksContainer(vector*>* &container)
{
if (container != NULL)
{
vector*>::iterator iter = container->begin();
while (iter < container->end())
{
delete *iter;
++iter;
}
container->clear();
delete (container);
container = NULL;
}
}
/**
* initialize a vector object
* T is the type of vector used for all vectors
*/
template
void ASBeautifier::initContainer(T &container, T value)
{
// since the ASFormatter object is never deleted,
// the existing vectors must be deleted before creating new ones
if (container != NULL )
deleteContainer(container);
container = value;
}
/**
* Initialize the tempStacks vector object.
* The tempStacks is a vector of pointers to strings allocated with the 'new' operator.
* Any residual entries are deleted before the vector is initialized.
*/
void ASBeautifier::initTempStacksContainer(vector*>* &container,
vector*>* value)
{
if (container != NULL)
deleteTempStacksContainer(container);
container = value;
}
/**
* Determine if an assignment statement ends with a comma
* that is not in a function argument. It ends with a
* comma if a comma is the last char on the line.
*
* @return true if line ends with a comma, otherwise false.
*/
bool ASBeautifier::statementEndsWithComma(const string &line, int index) const
{
assert(line[index] == '=');
bool isInComment_ = false;
bool isInQuote_ = false;
int parenCount = 0;
size_t lineLength = line.length();
size_t i = 0;
char quoteChar_ = ' ';
for (i = index + 1; i < lineLength; ++i)
{
char ch = line[i];
if (isInComment_)
{
if (line.compare(i, 2, "*/") == 0)
{
isInComment_ = false;
++i;
}
continue;
}
if (ch == '\\')
{
++i;
continue;
}
if (isInQuote_)
{
if (ch == quoteChar_)
isInQuote_ = false;
continue;
}
if (ch == '"' || ch == '\'')
{
isInQuote_ = true;
quoteChar_ = ch;
continue;
}
if (line.compare(i, 2, "//") == 0)
break;
if (line.compare(i, 2, "/*") == 0)
{
if (isLineEndComment(line, i))
break;
else
{
isInComment_ = true;
++i;
continue;
}
}
if (ch == '(')
parenCount++;
if (ch == ')')
parenCount--;
}
if (isInComment_
|| isInQuote_
|| parenCount > 0)
return false;
size_t lastChar = line.find_last_not_of(" \t", i - 1);
if (lastChar == string::npos || line[lastChar] != ',')
return false;
return true;
}
/**
* check if current comment is a line-end comment
*
* @return is before a line-end comment.
*/
bool ASBeautifier::isLineEndComment(const string &line, int startPos) const
{
assert(line.compare(startPos, 2, "/*") == 0);
// comment must be closed on this line with nothing after it
size_t endNum = line.find("*/", startPos + 2);
if (endNum != string::npos)
{
size_t nextChar = line.find_first_not_of(" \t", endNum + 2);
if (nextChar == string::npos)
return true;
}
return false;
}
/**
* get the previous word index for an assignment operator
*
* @return is the index to the previous word (the in statement indent).
*/
int ASBeautifier::getInStatementIndentAssign(const string &line, size_t currPos) const
{
assert(line[currPos] == '=');
if (currPos == 0)
return 0;
// get the last legal word (may be a number)
size_t end = line.find_last_not_of(" \t", currPos - 1);
if (end == string::npos || !isLegalNameChar(line[end]))
return 0;
int start; // start of the previous word
for (start = end; start > -1; start--)
{
if (!isLegalNameChar(line[start]) || line[start] == '.')
break;
}
start++;
return start;
}
/**
* get the instatement indent for a comma
*
* @return is the indent to the second word on the line (the in statement indent).
*/
int ASBeautifier::getInStatementIndentComma(const string &line, size_t currPos) const
{
assert(line[currPos] == ',');
// get first word on a line
size_t indent = line.find_first_not_of(" \t");
if (indent == string::npos || !isLegalNameChar(line[indent]))
return 0;
// bypass first word
for (; indent < currPos; indent++)
{
if (!isLegalNameChar(line[indent]))
break;
}
indent++;
if (indent >= currPos || indent < 4)
return 0;
// point to second word or assignment operator
indent = line.find_first_not_of(" \t", indent);
if (indent == string::npos || indent >= currPos)
return 0;
return indent;
}
/**
* get the next word on a line
* the argument 'currPos' must point to the current position.
*
* @return is the next word or an empty string if none found.
*/
string ASBeautifier::getNextWord(const string &line, size_t currPos) const
{
size_t lineLength = line.length();
// get the last legal word (may be a number)
if (currPos == lineLength - 1)
return string();
size_t start = line.find_first_not_of(" \t", currPos + 1);
if (start == string::npos || !isLegalNameChar(line[start]))
return string();
size_t end; // end of the current word
for (end = start + 1; end <= lineLength; end++)
{
if (!isLegalNameChar(line[end]) || line[end] == '.')
break;
}
return line.substr(start, end - start);
}
/**
* Check if a preprocessor directive is always indented.
* C# "region" and "endregion" are always indented.
* C/C++ "pragma omp" is always indented.
*
* @return is true or false.
*/
bool ASBeautifier::isIndentedPreprocessor(const string &line, size_t currPos) const
{
assert(line[0] == '#');
string nextWord = getNextWord(line, currPos);
if (nextWord == "region" || nextWord == "endregion")
return true;
// is it #pragma omp
if (nextWord == "pragma")
{
// find pragma
size_t start = line.find("pragma");
if (start == string::npos || !isLegalNameChar(line[start]))
return false;
// bypass pragma
for (; start < line.length(); start++)
{
if (!isLegalNameChar(line[start]))
break;
}
start++;
if (start >= line.length())
return false;
// point to start of second word
start = line.find_first_not_of(" \t", start);
if (start == string::npos)
return false;
// point to end of second word
size_t end;
for (end = start; end < line.length(); end++)
{
if (!isLegalNameChar(line[end]))
break;
}
// check for "pragma omp"
string word = line.substr(start, end - start);
if (word == "omp" || word == "region" || word == "endregion")
return true;
}
return false;
}
/**
* Check if a preprocessor directive is checking for __cplusplus defined.
*
* @return is true or false.
*/
bool ASBeautifier::isPreprocessorConditionalCplusplus(const string &line) const
{
string preproc = trim(line.substr(1));
if (preproc.compare(0, 5, "ifdef") == 0 && getNextWord(preproc, 4) == "__cplusplus")
return true;
if (preproc.compare(0, 2, "if") == 0)
{
// check for " #if defined(__cplusplus)"
size_t charNum = 2;
charNum = preproc.find_first_not_of(" \t", charNum);
if (preproc.compare(charNum, 7, "defined") == 0)
{
charNum += 7;
charNum = preproc.find_first_not_of(" \t", charNum);
if (preproc.compare(charNum, 1, "(") == 0)
{
++charNum;
charNum = preproc.find_first_not_of(" \t", charNum);
if (preproc.compare(charNum, 11, "__cplusplus") == 0)
return true;
}
}
}
return false;
}
/**
* Check if a preprocessor definition contains an unterminated comment.
* Comments within a preprocessor definition can be continued without the backslash.
*
* @return is true or false.
*/
bool ASBeautifier::isInPreprocessorUnterminatedComment(const string &line)
{
if (!isInPreprocessorComment)
{
size_t startPos = line.find("/*");
if (startPos == string::npos)
return false;
}
size_t endNum = line.find("*/");
if (endNum != string::npos)
{
isInPreprocessorComment = false;
return false;
}
isInPreprocessorComment = true;
return true;
}
void ASBeautifier::popLastInStatementIndent()
{
assert(!inStatementIndentStackSizeStack->empty());
int previousIndentStackSize = inStatementIndentStackSizeStack->back();
if (inStatementIndentStackSizeStack->size() > 1)
inStatementIndentStackSizeStack->pop_back();
while (previousIndentStackSize < (int) inStatementIndentStack->size())
inStatementIndentStack->pop_back();
}
// for unit testing
int ASBeautifier::getBeautifierFileType() const
{ return beautifierFileType; }
/**
* Process preprocessor statements and update the beautifier stacks.
*/
void ASBeautifier::processPreprocessor(const string &preproc, const string &line)
{
// When finding a multi-lined #define statement, the original beautifier
// 1. sets its isInDefineDefinition flag
// 2. clones a new beautifier that will be used for the actual indentation
// of the #define. This clone is put into the activeBeautifierStack in order
// to be called for the actual indentation.
// The original beautifier will have isInDefineDefinition = true, isInDefine = false
// The cloned beautifier will have isInDefineDefinition = true, isInDefine = true
if (shouldIndentPreprocDefine && preproc == "define" && line[line.length() - 1] == '\\')
{
if (!isInDefineDefinition)
{
ASBeautifier* defineBeautifier;
// this is the original beautifier
isInDefineDefinition = true;
// push a new beautifier into the active stack
// this beautifier will be used for the indentation of this define
defineBeautifier = new ASBeautifier(*this);
activeBeautifierStack->push_back(defineBeautifier);
}
else
{
// the is the cloned beautifier that is in charge of indenting the #define.
isInDefine = true;
}
}
else if (preproc.length() >= 2 && preproc.substr(0, 2) == "if")
{
if (isPreprocessorConditionalCplusplus(line) && !g_preprocessorCppExternCBracket)
g_preprocessorCppExternCBracket = 1;
// push a new beautifier into the stack
waitingBeautifierStackLengthStack->push_back(waitingBeautifierStack->size());
activeBeautifierStackLengthStack->push_back(activeBeautifierStack->size());
if (activeBeautifierStackLengthStack->back() == 0)
waitingBeautifierStack->push_back(new ASBeautifier(*this));
else
waitingBeautifierStack->push_back(new ASBeautifier(*activeBeautifierStack->back()));
}
else if (preproc == "else")
{
if (waitingBeautifierStack && !waitingBeautifierStack->empty())
{
// MOVE current waiting beautifier to active stack.
activeBeautifierStack->push_back(waitingBeautifierStack->back());
waitingBeautifierStack->pop_back();
}
}
else if (preproc == "elif")
{
if (waitingBeautifierStack && !waitingBeautifierStack->empty())
{
// append a COPY current waiting beautifier to active stack, WITHOUT deleting the original.
activeBeautifierStack->push_back(new ASBeautifier(*(waitingBeautifierStack->back())));
}
}
else if (preproc == "endif")
{
int stackLength;
ASBeautifier* beautifier;
if (waitingBeautifierStackLengthStack != NULL && !waitingBeautifierStackLengthStack->empty())
{
stackLength = waitingBeautifierStackLengthStack->back();
waitingBeautifierStackLengthStack->pop_back();
while ((int) waitingBeautifierStack->size() > stackLength)
{
beautifier = waitingBeautifierStack->back();
waitingBeautifierStack->pop_back();
delete beautifier;
}
}
if (!activeBeautifierStackLengthStack->empty())
{
stackLength = activeBeautifierStackLengthStack->back();
activeBeautifierStackLengthStack->pop_back();
while ((int) activeBeautifierStack->size() > stackLength)
{
beautifier = activeBeautifierStack->back();
activeBeautifierStack->pop_back();
delete beautifier;
}
}
}
}
// Compute the preliminary indentation based on data in the headerStack
// and data from previous lines.
// Update the class variable indentCount.
void ASBeautifier::computePreliminaryIndentation()
{
indentCount = 0;
spaceIndentCount = 0;
if (isInObjCMethodDefinition && !inStatementIndentStack->empty())
spaceIndentObjCMethodDefinition = inStatementIndentStack->back();
if (!inStatementIndentStack->empty())
spaceIndentCount = inStatementIndentStack->back();
for (size_t i = 0; i < headerStack->size(); i++)
{
isInClass = false;
if (blockIndent)
{
// do NOT indent opening block for these headers
if (!((*headerStack)[i] == &AS_NAMESPACE
|| (*headerStack)[i] == &AS_CLASS
|| (*headerStack)[i] == &AS_STRUCT
|| (*headerStack)[i] == &AS_UNION
|| (*headerStack)[i] == &AS_INTERFACE
|| (*headerStack)[i] == &AS_THROWS
|| (*headerStack)[i] == &AS_STATIC))
++indentCount;
}
else if (!(i > 0 && (*headerStack)[i - 1] != &AS_OPEN_BRACKET
&& (*headerStack)[i] == &AS_OPEN_BRACKET))
++indentCount;
if (!isJavaStyle() && !namespaceIndent && i > 0
&& (*headerStack)[i - 1] == &AS_NAMESPACE
&& (*headerStack)[i] == &AS_OPEN_BRACKET)
--indentCount;
if (isCStyle() && i >= 1
&& (*headerStack)[i - 1] == &AS_CLASS
&& (*headerStack)[i] == &AS_OPEN_BRACKET)
{
if (classIndent)
++indentCount;
isInClass = true;
}
// is the switchIndent option is on, indent switch statements an additional indent.
else if (switchIndent && i > 1
&& (*headerStack)[i - 1] == &AS_SWITCH
&& (*headerStack)[i] == &AS_OPEN_BRACKET)
{
++indentCount;
isInSwitch = true;
}
} // end of for loop
if (isInClassInitializer)
{
if (lineStartsInComment || lineOpensWithComment)
{
if (!lineBeginsWithOpenBracket)
--indentCount;
}
// is this class initializer (not in a class) or class definition?
else if (isCStyle()
&& (headerStack->empty() || headerStack->back() != &AS_CLASS))
{
isInClassHeaderTab = true;
indentCount += classInitializerIndents;
}
else if (blockIndent)
{
if (!lineBeginsWithOpenBracket)
++indentCount;
}
}
// Objective-C interface continuation line
if (isInObjCInterface)
++indentCount;
// unindent a class closing bracket...
if (!lineStartsInComment
&& isCStyle()
&& isInClass
&& classIndent
&& headerStack->size() >= 2
&& (*headerStack)[headerStack->size() - 2] == &AS_CLASS
&& (*headerStack)[headerStack->size() - 1] == &AS_OPEN_BRACKET
&& lineBeginsWithCloseBracket
&& bracketBlockStateStack->back() == true)
--indentCount;
// unindent an indented switch closing bracket...
else if (!lineStartsInComment
&& isInSwitch
&& switchIndent
&& headerStack->size() >= 2
&& (*headerStack)[headerStack->size() - 2] == &AS_SWITCH
&& (*headerStack)[headerStack->size() - 1] == &AS_OPEN_BRACKET
&& lineBeginsWithCloseBracket)
--indentCount;
// handle special case of horstmann comment in an indented class statement
if (isInClass
&& classIndent
&& isInHorstmannComment
&& !lineOpensWithComment
&& headerStack->size() > 1
&& (*headerStack)[headerStack->size() - 2] == &AS_CLASS)
--indentCount;
if (isInConditional)
--indentCount;
if (g_preprocessorCppExternCBracket >= 4)
--indentCount;
}
void ASBeautifier::adjustParsedLineIndentation(size_t iPrelim, bool isInExtraHeaderIndent)
{
if (lineStartsInComment)
return;
// unindent a one-line statement in a header indent
if (!blockIndent
&& lineBeginsWithOpenBracket
&& headerStack->size() < iPrelim
&& isInExtraHeaderIndent
&& (lineOpeningBlocksNum > 0 && lineOpeningBlocksNum <= lineClosingBlocksNum)
&& shouldIndentBrackettedLine)
--indentCount;
/*
* if '{' doesn't follow an immediately previous '{' in the headerStack
* (but rather another header such as "for" or "if", then unindent it
* by one indentation relative to its block.
*/
else if (!blockIndent
&& lineBeginsWithOpenBracket
&& !(lineOpeningBlocksNum > 0 && lineOpeningBlocksNum <= lineClosingBlocksNum)
&& (headerStack->size() > 1 && (*headerStack)[headerStack->size() - 2] != &AS_OPEN_BRACKET)
&& shouldIndentBrackettedLine)
--indentCount;
// must check one less in headerStack if more than one header on a line (allow-addins)...
else if (headerStack->size() > iPrelim + 1
&& !blockIndent
&& lineBeginsWithOpenBracket
&& !(lineOpeningBlocksNum > 0 && lineOpeningBlocksNum <= lineClosingBlocksNum)
&& (headerStack->size() > 2 && (*headerStack)[headerStack->size() - 3] != &AS_OPEN_BRACKET)
&& shouldIndentBrackettedLine)
--indentCount;
// unindent a closing bracket...
else if (lineBeginsWithCloseBracket
&& shouldIndentBrackettedLine)
--indentCount;
// correctly indent one-line-blocks...
else if (lineOpeningBlocksNum > 0
&& lineOpeningBlocksNum == lineClosingBlocksNum
&& previousLineProbationTab)
--indentCount;
// correctly indent class continuation lines...
else if (!lineOpensWithComment
&& isInClassHeaderTab
&& !blockIndent
&& lineOpeningBlocksNum == 0
&& lineOpeningBlocksNum == lineClosingBlocksNum
&& (!headerStack->empty() && headerStack->back() == &AS_CLASS))
--indentCount;
if (indentCount < 0)
indentCount = 0;
// take care of extra bracket indentation option...
if (!lineStartsInComment
&& bracketIndent
&& shouldIndentBrackettedLine
&& (lineBeginsWithOpenBracket || lineBeginsWithCloseBracket))
++indentCount;
}
/**
* Compute indentCount adjustment when in a series of else-if statements
* and shouldBreakElseIfs is requested.
* It increments by one for each 'else' in the tempStack.
*/
int ASBeautifier::adjustIndentCountForBreakElseIfComments() const
{
assert(isElseHeaderIndent && !tempStacks->empty());
int indentCountIncrement = 0;
vector* lastTempStack = tempStacks->back();
if (lastTempStack != NULL)
{
for (size_t i = 0; i < lastTempStack->size(); i++)
{
if (*lastTempStack->at(i) == AS_ELSE)
indentCountIncrement++;
}
}
return indentCountIncrement;
}
/**
* Extract a preprocessor statement without the #.
* If a error occurs an empty string is returned.
*/
string ASBeautifier::extractPreprocessorStatement(const string &line) const
{
string preproc;
size_t start = line.find_first_not_of("#/ \t");
if (start == string::npos)
return preproc;
size_t end = line.find_first_of("/ \t", start);
if (end == string::npos)
end = line.length();
preproc = line.substr(start, end - start);
return preproc;
}
/**
* Clear the variables used to align the Objective-C method definitions.
*/
void ASBeautifier::clearObjCMethodDefinitionAlignment()
{
assert(isImmediatelyPostObjCMethodDefinition);
spaceIndentCount = 0;
spaceIndentObjCMethodDefinition = 0;
colonIndentObjCMethodDefinition = 0;
isInObjCMethodDefinition = false;
isImmediatelyPostObjCMethodDefinition = false;
if (!inStatementIndentStack->empty())
inStatementIndentStack->pop_back();
}
/**
* Compute the spaceIndentCount necessary to align the current line colon
* with the colon position in the argument.
* If it cannot be aligned indentLength is returned and a new colon
* position is calculated.
*/
int ASBeautifier::computeObjCColonAlignment(string &line, int colonAlignPosition) const
{
int colonPosition = line.find(':');
if (colonPosition < 0 || colonPosition > colonAlignPosition)
return indentLength;
return (colonAlignPosition - colonPosition);
}
/**
* Parse the current line to update indentCount and spaceIndentCount.
*/
void ASBeautifier::parseCurrentLine(const string &line)
{
bool isInLineComment = false;
bool isInOperator = false;
bool isSpecialChar = false;
bool haveCaseIndent = false;
bool haveAssignmentThisLine = false;
bool closingBracketReached = false;
bool previousLineProbation = (probationHeader != NULL);
char ch = ' ';
int tabIncrementIn = 0;
for (size_t i = 0; i < line.length(); i++)
{
ch = line[i];
if (isInBeautifySQL)
continue;
if (isWhiteSpace(ch))
{
if (ch == '\t')
tabIncrementIn += convertTabToSpaces(i, tabIncrementIn);
continue;
}
// handle special characters (i.e. backslash+character such as \n, \t, ...)
if (isInQuote && !isInVerbatimQuote)
{
if (isSpecialChar)
{
isSpecialChar = false;
continue;
}
if (line.compare(i, 2, "\\\\") == 0)
{
i++;
continue;
}
if (ch == '\\')
{
if (peekNextChar(line, i) == ' ') // is this '\' at end of line
haveLineContinuationChar = true;
else
isSpecialChar = true;
continue;
}
}
else if (isInDefine && ch == '\\')
continue;
// handle quotes (such as 'x' and "Hello Dolly")
if (!(isInComment || isInLineComment) && (ch == '"' || ch == '\''))
{
if (!isInQuote)
{
quoteChar = ch;
isInQuote = true;
char prevCh = i > 0 ? line[i - 1] : ' ';
if (isCStyle() && prevCh == 'R')
{
int parenPos = line.find('(', i);
if (parenPos != -1)
{
isInVerbatimQuote = true;
verbatimDelimiter = line.substr(i + 1, parenPos - i - 1);
}
}
else if (isSharpStyle() && prevCh == '@')
isInVerbatimQuote = true;
// check for "C" following "extern"
else if (g_preprocessorCppExternCBracket == 2 && line.compare(i, 3, "\"C\"") == 0)
++g_preprocessorCppExternCBracket;
}
else if (isInVerbatimQuote && ch == '"')
{
if (isCStyle())
{
string delim = ')' + verbatimDelimiter;
int delimStart = i - delim.length();
if (delimStart > 0 && line.substr(delimStart, delim.length()) == delim)
{
isInQuote = false;
isInVerbatimQuote = false;
}
}
else if (isSharpStyle())
{
if (peekNextChar(line, i) == '"') // check consecutive quotes
i++;
else
{
isInQuote = false;
isInVerbatimQuote = false;
}
}
}
else if (quoteChar == ch)
{
isInQuote = false;
isInStatement = true;
continue;
}
}
if (isInQuote)
continue;
// handle comments
if (!(isInComment || isInLineComment) && line.compare(i, 2, "//") == 0)
{
// if there is a 'case' statement after these comments unindent by 1
if (isCaseHeaderCommentIndent)
--indentCount;
// isElseHeaderIndent is set by ASFormatter if shouldBreakElseIfs is requested
// if there is an 'else' after these comments a tempStacks indent is required
if (isElseHeaderIndent && lineOpensWithLineComment && !tempStacks->empty())
indentCount += adjustIndentCountForBreakElseIfComments();
isInLineComment = true;
i++;
continue;
}
else if (!(isInComment || isInLineComment) && line.compare(i, 2, "/*") == 0)
{
// if there is a 'case' statement after these comments unindent by 1
if (isCaseHeaderCommentIndent && lineOpensWithComment)
--indentCount;
// isElseHeaderIndent is set by ASFormatter if shouldBreakElseIfs is requested
// if there is an 'else' after these comments a tempStacks indent is required
if (isElseHeaderIndent && lineOpensWithComment && !tempStacks->empty())
indentCount += adjustIndentCountForBreakElseIfComments();
isInComment = true;
i++;
if (!lineOpensWithComment) // does line start with comment?
blockCommentNoIndent = true; // if no, cannot indent continuation lines
continue;
}
else if ((isInComment || isInLineComment) && line.compare(i, 2, "*/") == 0)
{
size_t firstText = line.find_first_not_of(" \t");
// if there is a 'case' statement after these comments unindent by 1
// only if the ending comment is the first entry on the line
if (isCaseHeaderCommentIndent && firstText == i)
--indentCount;
// if this comment close starts the line, must check for else-if indent
// isElseHeaderIndent is set by ASFormatter if shouldBreakElseIfs is requested
// if there is an 'else' after these comments a tempStacks indent is required
if (firstText == i)
{
if (isElseHeaderIndent && !lineOpensWithComment && !tempStacks->empty())
indentCount += adjustIndentCountForBreakElseIfComments();
}
isInComment = false;
i++;
blockCommentNoIndent = false; // ok to indent next comment
continue;
}
// treat indented preprocessor lines as a line comment
else if (line[0] == '#' && isIndentedPreprocessor(line, i))
{
isInLineComment = true;
}
if (isInLineComment)
{
// bypass rest of the comment up to the comment end
while (i + 1 < line.length())
i++;
continue;
}
if (isInComment)
{
// if there is a 'case' statement after these comments unindent by 1
if (!lineOpensWithComment && isCaseHeaderCommentIndent)
--indentCount;
// isElseHeaderIndent is set by ASFormatter if shouldBreakElseIfs is requested
// if there is an 'else' after these comments a tempStacks indent is required
if (!lineOpensWithComment && isElseHeaderIndent && !tempStacks->empty())
indentCount += adjustIndentCountForBreakElseIfComments();
// bypass rest of the comment up to the comment end
while (i + 1 < line.length()
&& line.compare(i + 1, 2, "*/") != 0)
i++;
continue;
}
// if we have reached this far then we are NOT in a comment or string of special character...
if (probationHeader != NULL)
{
if ((probationHeader == &AS_STATIC && ch == '{')
|| (probationHeader == &AS_SYNCHRONIZED && ch == '('))
{
// insert the probation header as a new header
isInHeader = true;
headerStack->push_back(probationHeader);
// handle the specific probation header
isInConditional = (probationHeader == &AS_SYNCHRONIZED);
isInStatement = false;
// if the probation comes from the previous line, then indent by 1 tab count.
if (previousLineProbation
&& ch == '{'
&& !(blockIndent && probationHeader == &AS_STATIC))
{
++indentCount;
previousLineProbationTab = true;
}
previousLineProbation = false;
}
// dismiss the probation header
probationHeader = NULL;
}
prevNonSpaceCh = currentNonSpaceCh;
currentNonSpaceCh = ch;
if (!isLegalNameChar(ch) && ch != ',' && ch != ';')
{
prevNonLegalCh = currentNonLegalCh;
currentNonLegalCh = ch;
}
if (isInHeader)
{
isInHeader = false;
currentHeader = headerStack->back();
}
else
currentHeader = NULL;
if (isCStyle() && isInTemplate
&& (ch == '<' || ch == '>')
&& !(line.length() > i + 1 && line.compare(i, 2, ">=") == 0))
{
if (ch == '<')
{
++templateDepth;
inStatementIndentStackSizeStack->push_back(inStatementIndentStack->size());
registerInStatementIndent(line, i, spaceIndentCount, tabIncrementIn, 0, true);
}
else if (ch == '>')
{
popLastInStatementIndent();
if (--templateDepth <= 0)
{
ch = ';';
isInTemplate = false;
templateDepth = 0;
}
}
}
// handle parentheses
if (ch == '(' || ch == '[' || ch == ')' || ch == ']')
{
if (ch == '(' || ch == '[')
{
isInOperator = false;
// if have a struct header, this is a declaration not a definition
if (ch == '('
&& (isInClassInitializer || isInClassHeaderTab)
&& !headerStack->empty()
&& headerStack->back() == &AS_STRUCT)
{
headerStack->pop_back();
isInClassInitializer = false;
// -1 for isInClassInitializer, -2 for isInClassHeaderTab
if (isInClassHeaderTab)
{
indentCount -= (1 + classInitializerIndents);
isInClassHeaderTab = false;
}
if (indentCount < 0)
indentCount = 0;
}
if (parenDepth == 0)
{
parenStatementStack->push_back(isInStatement);
isInStatement = true;
}
parenDepth++;
if (ch == '[')
++squareBracketCount;
inStatementIndentStackSizeStack->push_back(inStatementIndentStack->size());
if (currentHeader != NULL)
registerInStatementIndent(line, i, spaceIndentCount, tabIncrementIn, minConditionalIndent/*indentLength*2*/, true);
else
registerInStatementIndent(line, i, spaceIndentCount, tabIncrementIn, 0, true);
}
else if (ch == ')' || ch == ']')
{
if (ch == ']')
--squareBracketCount;
if (squareBracketCount < 0)
squareBracketCount = 0;
foundPreCommandHeader = false;
parenDepth--;
if (parenDepth == 0)
{
if (!parenStatementStack->empty()) // in case of unmatched closing parens
{
isInStatement = parenStatementStack->back();
parenStatementStack->pop_back();
}
ch = ' ';
isInAsm = false;
isInConditional = false;
}
if (!inStatementIndentStackSizeStack->empty())
{
popLastInStatementIndent();
if (!parenIndentStack->empty())
{
int poppedIndent = parenIndentStack->back();
parenIndentStack->pop_back();
if (i == 0)
spaceIndentCount = poppedIndent;
}
}
}
continue;
}
if (ch == '{')
{
// first, check if '{' is a block-opener or a static-array opener
bool isBlockOpener = ((prevNonSpaceCh == '{' && bracketBlockStateStack->back())
|| prevNonSpaceCh == '}'
|| prevNonSpaceCh == ')'
|| prevNonSpaceCh == ';'
|| peekNextChar(line, i) == '{'
|| foundPreCommandHeader
|| foundPreCommandMacro
|| isInClassInitializer
|| isNonInStatementArray
|| isInObjCMethodDefinition
|| isInObjCInterface
|| isSharpAccessor
|| isSharpDelegate
|| isInExternC
|| getNextWord(line, i) == AS_NEW
|| (isInDefine &&
(prevNonSpaceCh == '('
|| isLegalNameChar(prevNonSpaceCh))));
// remove inStatementIndent for C++ class initializer
if (isInClassInitializer)
{
if (!inStatementIndentStack->empty())
inStatementIndentStack->pop_back();
isInStatement = false;
if (lineBeginsWithOpenBracket)
spaceIndentCount = 0;
isInClassInitializer = false;
}
if (isInObjCMethodDefinition)
isImmediatelyPostObjCMethodDefinition = true;
if (!isBlockOpener && !isInStatement && !isInEnum)
{
if (headerStack->empty())
isBlockOpener = true;
else if (headerStack->back() == &AS_NAMESPACE
|| headerStack->back() == &AS_CLASS
|| headerStack->back() == &AS_STRUCT)
isBlockOpener = true;
}
if (!isBlockOpener && currentHeader != NULL)
{
for (size_t n = 0; n < nonParenHeaders->size(); n++)
if (currentHeader == (*nonParenHeaders)[n])
{
isBlockOpener = true;
break;
}
}
bracketBlockStateStack->push_back(isBlockOpener);
if (!isBlockOpener)
{
inStatementIndentStackSizeStack->push_back(inStatementIndentStack->size());
registerInStatementIndent(line, i, spaceIndentCount, tabIncrementIn, 0, true);
parenDepth++;
if (i == 0)
shouldIndentBrackettedLine = false;
continue;
}
// this bracket is a block opener...
++lineOpeningBlocksNum;
if (isInClassHeaderTab)
{
isInClassHeaderTab = false;
// decrease tab count if bracket is broken
size_t firstChar = line.find_first_not_of(" \t");
if (firstChar != string::npos
&& line[firstChar] == '{'
&& firstChar == i)
{
indentCount -= classInitializerIndents;
// decrease one more if an empty class
if (!headerStack->empty()
&& (*headerStack).back() == &AS_CLASS)
{
int nextChar = getNextProgramCharDistance(line, i);
if ((int)line.length() > nextChar && line[nextChar] == '}')
--indentCount;
}
}
}
if (isInObjCInterface)
{
isInObjCInterface = false;
if (lineBeginsWithOpenBracket)
--indentCount;
}
if (bracketIndent && !namespaceIndent && !headerStack->empty()
&& (*headerStack).back() == &AS_NAMESPACE)
{
shouldIndentBrackettedLine = false;
--indentCount;
}
// an indentable struct is treated like a class in the header stack
if (!headerStack->empty()
&& (*headerStack).back() == &AS_STRUCT
&& isInIndentableStruct)
(*headerStack).back() = &AS_CLASS;
blockParenDepthStack->push_back(parenDepth);
blockStatementStack->push_back(isInStatement);
if (!inStatementIndentStack->empty())
{
// completely purge the inStatementIndentStack
while (!inStatementIndentStack->empty())
popLastInStatementIndent();
spaceIndentCount = 0;
}
blockTabCount += (isInStatement ? 1 : 0);
if (g_preprocessorCppExternCBracket == 3)
++g_preprocessorCppExternCBracket;
parenDepth = 0;
isInStatement = false;
isInQuestion = false;
foundPreCommandHeader = false;
foundPreCommandMacro = false;
isInExternC = false;
tempStacks->push_back(new vector);
headerStack->push_back(&AS_OPEN_BRACKET);
lastLineHeader = &AS_OPEN_BRACKET;
continue;
} // end '{'
//check if a header has been reached
bool isPotentialHeader = isCharPotentialHeader(line, i);
if (isPotentialHeader && !squareBracketCount)
{
const string* newHeader = findHeader(line, i, headers);
if (newHeader != NULL)
{
// if we reached here, then this is a header...
bool isIndentableHeader = true;
isInHeader = true;
vector* lastTempStack;
if (tempStacks->empty())
lastTempStack = NULL;
else
lastTempStack = tempStacks->back();
// if a new block is opened, push a new stack into tempStacks to hold the
// future list of headers in the new block.
// take care of the special case: 'else if (...)'
if (newHeader == &AS_IF && lastLineHeader == &AS_ELSE)
{
headerStack->pop_back();
}
// take care of 'else'
else if (newHeader == &AS_ELSE)
{
if (lastTempStack != NULL)
{
int indexOfIf = indexOf(*lastTempStack, &AS_IF);
if (indexOfIf != -1)
{
// recreate the header list in headerStack up to the previous 'if'
// from the temporary snapshot stored in lastTempStack.
int restackSize = lastTempStack->size() - indexOfIf - 1;
for (int r = 0; r < restackSize; r++)
{
headerStack->push_back(lastTempStack->back());
lastTempStack->pop_back();
}
if (!closingBracketReached)
indentCount += restackSize;
}
/*
* If the above if is not true, i.e. no 'if' before the 'else',
* then nothing beautiful will come out of this...
* I should think about inserting an Exception here to notify the caller of this...
*/
}
}
// check if 'while' closes a previous 'do'
else if (newHeader == &AS_WHILE)
{
if (lastTempStack != NULL)
{
int indexOfDo = indexOf(*lastTempStack, &AS_DO);
if (indexOfDo != -1)
{
// recreate the header list in headerStack up to the previous 'do'
// from the temporary snapshot stored in lastTempStack.
int restackSize = lastTempStack->size() - indexOfDo - 1;
for (int r = 0; r < restackSize; r++)
{
headerStack->push_back(lastTempStack->back());
lastTempStack->pop_back();
}
if (!closingBracketReached)
indentCount += restackSize;
}
}
}
// check if 'catch' closes a previous 'try' or 'catch'
else if (newHeader == &AS_CATCH || newHeader == &AS_FINALLY)
{
if (lastTempStack != NULL)
{
int indexOfTry = indexOf(*lastTempStack, &AS_TRY);
if (indexOfTry == -1)
indexOfTry = indexOf(*lastTempStack, &AS_CATCH);
if (indexOfTry != -1)
{
// recreate the header list in headerStack up to the previous 'try'
// from the temporary snapshot stored in lastTempStack.
int restackSize = lastTempStack->size() - indexOfTry - 1;
for (int r = 0; r < restackSize; r++)
{
headerStack->push_back(lastTempStack->back());
lastTempStack->pop_back();
}
if (!closingBracketReached)
indentCount += restackSize;
}
}
}
else if (newHeader == &AS_CASE)
{
isInCase = true;
if (!haveCaseIndent)
{
haveCaseIndent = true;
if (!lineBeginsWithOpenBracket)
--indentCount;
}
}
else if (newHeader == &AS_DEFAULT)
{
isInCase = true;
--indentCount;
}
else if (newHeader == &AS_STATIC
|| newHeader == &AS_SYNCHRONIZED)
{
if (!headerStack->empty() &&
(headerStack->back() == &AS_STATIC
|| headerStack->back() == &AS_SYNCHRONIZED))
{
isIndentableHeader = false;
}
else
{
isIndentableHeader = false;
probationHeader = newHeader;
}
}
else if (newHeader == &AS_TEMPLATE)
{
isInTemplate = true;
isIndentableHeader = false;
}
if (isIndentableHeader)
{
headerStack->push_back(newHeader);
isInStatement = false;
if (indexOf(*nonParenHeaders, newHeader) == -1)
{
isInConditional = true;
}
lastLineHeader = newHeader;
}
else
isInHeader = false;
i += newHeader->length() - 1;
continue;
} // newHeader != NULL
if (findHeader(line, i, preCommandHeaders))
foundPreCommandHeader = true;
// Objective-C NSException macros are preCommandHeaders
if (isCStyle() && findKeyword(line, i, AS_NS_DURING))
foundPreCommandMacro = true;
if (isCStyle() && findKeyword(line, i, AS_NS_HANDLER))
foundPreCommandMacro = true;
// this applies only to C enums
if (isCStyle() && parenDepth == 0 && findKeyword(line, i, AS_ENUM))
isInEnum = true;
} // isPotentialHeader
if (ch == '?')
isInQuestion = true;
// special handling of colons
if (ch == ':')
{
if (line.length() > i + 1 && line[i + 1] == ':') // look for ::
{
++i;
ch = ' ';
continue;
}
else if (isInQuestion)
{
// do nothing special
}
else if (parenDepth > 0)
{
// found an objective-C statement
// so do nothing special
}
else if (isInEnum)
{
// found an enum with a base-type
// so do nothing special
}
else if (!headerStack->empty()
&& headerStack->back() == &AS_FOR
&& parenDepth > 0)
{
// found a range-based 'for' loop 'for (auto i : container)'
// so do nothing special
}
else if (isInClassInitializer || isInObjCInterface)
{
// is in a 'class A : public B' definition
// so do nothing special
}
else if (isInAsm || isInAsmOneLine || isInAsmBlock)
{
// do nothing special
}
else if (isDigit(peekNextChar(line, i)))
{
// found a bit field
// so do nothing special
}
else if (isCStyle() && isInClass && prevNonSpaceCh != ')')
{
// found a 'private:' or 'public:' inside a class definition
--indentCount;
if (modifierIndent)
spaceIndentCount += (indentLength / 2);
}
else if (isCStyle() && !isInClass
&& headerStack->size() >= 2
&& (*headerStack)[headerStack->size() - 2] == &AS_CLASS
&& (*headerStack)[headerStack->size() - 1] == &AS_OPEN_BRACKET)
{
// found a 'private:' or 'public:' inside a class definition
// and on the same line as the class opening bracket
// do nothing
}
else if (isCStyle() && prevNonSpaceCh == ')' && !isInCase)
{
// found a 'class A : public B' definition
isInClassInitializer = true;
isInStatement = false; // so an inStatement indent will register
if (i == 0)
indentCount += classInitializerIndents;
}
else if (isJavaStyle() && lastLineHeader == &AS_FOR)
{
// found a java for-each statement
// so do nothing special
}
else
{
currentNonSpaceCh = ';'; // so that brackets after the ':' will appear as block-openers
char peekedChar = peekNextChar(line, i);
if (isInCase)
{
isInCase = false;
ch = ';'; // from here on, treat char as ';'
}
else if (isCStyle() || (isSharpStyle() && peekedChar == ';'))
{
// is in a label (e.g. 'label1:')
if (labelIndent)
--indentCount; // unindent label by one indent
else if (!lineBeginsWithOpenBracket)
indentCount = 0; // completely flush indent to left
}
}
}
if ((ch == ';' || (parenDepth > 0 && ch == ',')) && !inStatementIndentStackSizeStack->empty())
while ((int) inStatementIndentStackSizeStack->back() + (parenDepth > 0 ? 1 : 0)
< (int) inStatementIndentStack->size())
inStatementIndentStack->pop_back();
else if (ch == ',' && isInEnum && isNonInStatementArray && !inStatementIndentStack->empty())
inStatementIndentStack->pop_back();
// handle commas
// previous "isInStatement" will be from an assignment operator or class initializer
if (ch == ',' && parenDepth == 0 && !isInStatement && !isNonInStatementArray)
{
// is comma at end of line
size_t nextChar = line.find_first_not_of(" \t", i + 1);
if (nextChar != string::npos)
{
if (line.compare(nextChar, 2, "//") == 0
|| line.compare(nextChar, 2, "/*") == 0)
nextChar = string::npos;
}
// register indent
if (nextChar == string::npos)
{
// register indent at first word after the colon of a C++ class initializer
if (isInClassInitializer)
{
size_t firstChar = line.find_first_not_of(" \t");
if (firstChar != string::npos && line[firstChar] == ':')
{
size_t firstWord = line.find_first_not_of(" \t", firstChar + 1);
if (firstChar != string::npos)
{
int inStatementIndent = firstWord + spaceIndentCount + tabIncrementIn;
inStatementIndentStack->push_back(inStatementIndent);
isInStatement = true;
}
}
}
// register indent at previous word
else if (!isInTemplate)
{
int prevWord = getInStatementIndentComma(line, i);
int inStatementIndent = prevWord + spaceIndentCount + tabIncrementIn;
inStatementIndentStack->push_back(inStatementIndent);
isInStatement = true;
}
}
}
// handle ends of statements
if ((ch == ';' && parenDepth == 0) || ch == '}')
{
if (ch == '}')
{
// first check if this '}' closes a previous block, or a static array...
if (bracketBlockStateStack->size() > 1)
{
bool bracketBlockState = bracketBlockStateStack->back();
bracketBlockStateStack->pop_back();
if (!bracketBlockState)
{
if (!inStatementIndentStackSizeStack->empty())
{
// this bracket is a static array
popLastInStatementIndent();
parenDepth--;
if (i == 0)
shouldIndentBrackettedLine = false;
if (!parenIndentStack->empty())
{
int poppedIndent = parenIndentStack->back();
parenIndentStack->pop_back();
if (i == 0)
spaceIndentCount = poppedIndent;
}
}
continue;
}
}
// this bracket is block closer...
++lineClosingBlocksNum;
if (!inStatementIndentStackSizeStack->empty())
popLastInStatementIndent();
if (!blockParenDepthStack->empty())
{
parenDepth = blockParenDepthStack->back();
blockParenDepthStack->pop_back();
isInStatement = blockStatementStack->back();
blockStatementStack->pop_back();
if (isInStatement)
blockTabCount--;
}
closingBracketReached = true;
if (i == 0)
spaceIndentCount = 0;
// close these just in case
isInAsm = isInAsmOneLine = isInQuote = false;
int headerPlace = indexOf(*headerStack, &AS_OPEN_BRACKET);
if (headerPlace != -1)
{
const string* popped = headerStack->back();
while (popped != &AS_OPEN_BRACKET)
{
headerStack->pop_back();
popped = headerStack->back();
}
headerStack->pop_back();
if (headerStack->empty())
g_preprocessorCppExternCBracket = 0;
// do not indent namespace bracket unless namespaces are indented
if (!namespaceIndent && !headerStack->empty()
&& (*headerStack).back() == &AS_NAMESPACE
&& i == 0) // must be the first bracket on the line
shouldIndentBrackettedLine = false;
if (!tempStacks->empty())
{
vector* temp = tempStacks->back();
tempStacks->pop_back();
delete temp;
}
}
ch = ' '; // needed due to cases such as '}else{', so that headers ('else' tn tih case) will be identified...
} // ch == '}'
/*
* Create a temporary snapshot of the current block's header-list in the
* uppermost inner stack in tempStacks, and clear the headerStack up to
* the beginning of the block.
* Thus, the next future statement will think it comes one indent past
* the block's '{' unless it specifically checks for a companion-header
* (such as a previous 'if' for an 'else' header) within the tempStacks,
* and recreates the temporary snapshot by manipulating the tempStacks.
*/
if (!tempStacks->back()->empty())
while (!tempStacks->back()->empty())
tempStacks->back()->pop_back();
while (!headerStack->empty() && headerStack->back() != &AS_OPEN_BRACKET)
{
tempStacks->back()->push_back(headerStack->back());
headerStack->pop_back();
}
if (parenDepth == 0 && ch == ';')
isInStatement = false;
if (isInObjCMethodDefinition)
isImmediatelyPostObjCMethodDefinition = true;
previousLastLineHeader = NULL;
isInClassInitializer = false;
isInEnum = false;
isInQuestion = false;
isInObjCInterface = false;
foundPreCommandHeader = false;
foundPreCommandMacro = false;
squareBracketCount = 0;
continue;
}
if (isPotentialHeader)
{
// check for preBlockStatements in C/C++ ONLY if not within parentheses
// (otherwise 'struct XXX' statements would be wrongly interpreted...)
if (!isInTemplate && !(isCStyle() && parenDepth > 0))
{
const string* newHeader = findHeader(line, i, preBlockStatements);
if (newHeader != NULL
&& !(isCStyle() && newHeader == &AS_CLASS && isInEnum)) // is it 'enum class'
{
isInClassInitializer = true;
if (!isSharpStyle())
headerStack->push_back(newHeader);
// do not need 'where' in the headerStack
// do not need second 'class' statement in a row
else if (!(newHeader == &AS_WHERE
|| (newHeader == &AS_CLASS
&& !headerStack->empty()
&& headerStack->back() == &AS_CLASS)))
headerStack->push_back(newHeader);
i += newHeader->length() - 1;
continue;
}
}
const string* foundIndentableHeader = findHeader(line, i, indentableHeaders);
if (foundIndentableHeader != NULL)
{
// must bypass the header before registering the in statement
i += foundIndentableHeader->length() - 1;
if (!isInOperator && !isInTemplate && !isNonInStatementArray)
{
registerInStatementIndent(line, i, spaceIndentCount, tabIncrementIn, 0, false);
isInStatement = true;
}
continue;
}
if (isCStyle() && findKeyword(line, i, AS_OPERATOR))
isInOperator = true;
if (g_preprocessorCppExternCBracket == 1 && findKeyword(line, i, AS_EXTERN))
++g_preprocessorCppExternCBracket;
if (g_preprocessorCppExternCBracket == 3) // extern "C" is not followed by a '{'
g_preprocessorCppExternCBracket = 0;
// "new" operator is a pointer, not a calculation
if (findKeyword(line, i, AS_NEW))
{
if (isInStatement && !inStatementIndentStack->empty() && prevNonSpaceCh == '=' )
inStatementIndentStack->back() = 0;
}
if (isCStyle())
{
if (findKeyword(line, i, AS_ASM)
|| findKeyword(line, i, AS__ASM__))
{
isInAsm = true;
}
else if (findKeyword(line, i, AS_MS_ASM) // microsoft specific
|| findKeyword(line, i, AS_MS__ASM))
{
int index = 4;
if (peekNextChar(line, i) == '_') // check for __asm
index = 5;
char peekedChar = ASBase::peekNextChar(line, i + index);
if (peekedChar == '{' || peekedChar == ' ')
isInAsmBlock = true;
else
isInAsmOneLine = true;
}
}
// bypass the entire name for all others
string name = getCurrentWord(line, i);
i += name.length() - 1;
continue;
}
// Handle Objective-C statements
if (ch == '@'
&& isCharPotentialHeader(line, i + 1))
{
string curWord = getCurrentWord(line, i + 1);
if (curWord == AS_INTERFACE && headerStack->empty())
{
isInObjCInterface = true;
string name = '@' + curWord;
i += name.length() - 1;
continue;
}
else if (curWord == AS_PUBLIC
|| curWord == AS_PRIVATE
|| curWord == AS_PROTECTED)
{
--indentCount;
if (modifierIndent)
spaceIndentCount += (indentLength / 2);
string name = '@' + curWord;
i += name.length() - 1;
continue;
}
else if (curWord == AS_END)
{
if (isInObjCInterface)
--indentCount;
isInObjCInterface = false;
isInObjCMethodDefinition = false;
string name = '@' + curWord;
i += name.length() - 1;
continue;
}
}
else if ((ch == '-' || ch == '+')
&& peekNextChar(line, i) == '('
&& headerStack->empty()
&& line.find_first_not_of(" \t") == i)
{
if (isInObjCInterface)
--indentCount;
isInObjCInterface = false;
isInObjCMethodDefinition = true;
continue;
}
// Handle operators
bool isPotentialOperator = isCharPotentialOperator(ch);
if (isPotentialOperator)
{
// Check if an operator has been reached.
const string* foundAssignmentOp = findOperator(line, i, assignmentOperators);
const string* foundNonAssignmentOp = findOperator(line, i, nonAssignmentOperators);
if (foundNonAssignmentOp == &AS_LAMBDA)
foundPreCommandHeader = true;
if (isInTemplate && foundNonAssignmentOp == &AS_GR_GR)
foundNonAssignmentOp = NULL;
// Since findHeader's boundary checking was not used above, it is possible
// that both an assignment op and a non-assignment op where found,
// e.g. '>>' and '>>='. If this is the case, treat the LONGER one as the
// found operator.
if (foundAssignmentOp != NULL && foundNonAssignmentOp != NULL)
{
if (foundAssignmentOp->length() < foundNonAssignmentOp->length())
foundAssignmentOp = NULL;
else
foundNonAssignmentOp = NULL;
}
if (foundNonAssignmentOp != NULL)
{
if (foundNonAssignmentOp->length() > 1)
i += foundNonAssignmentOp->length() - 1;
// For C++ input/output, operator<< and >> should be
// aligned, if we are not in a statement already and
// also not in the "operator<<(...)" header line
if (!isInOperator
&& inStatementIndentStack->empty()
&& isCStyle()
&& (foundNonAssignmentOp == &AS_GR_GR ||
foundNonAssignmentOp == &AS_LS_LS))
{
// this will be true if the line begins with the operator
if (i < 2 && spaceIndentCount == 0)
spaceIndentCount += 2 * indentLength;
// align to the beginning column of the operator
registerInStatementIndent(line, i - foundNonAssignmentOp->length(), spaceIndentCount, tabIncrementIn, 0, false);
}
}
else if (foundAssignmentOp != NULL)
{
foundPreCommandHeader = false; // clears this for array assignments
foundPreCommandMacro = false;
if (foundAssignmentOp->length() > 1)
i += foundAssignmentOp->length() - 1;
if (!isInOperator && !isInTemplate && (!isNonInStatementArray || isInEnum))
{
// if multiple assignments, align on the previous word
if (foundAssignmentOp == &AS_ASSIGN
&& prevNonSpaceCh != ']' // an array
&& statementEndsWithComma(line, i))
{
if (!haveAssignmentThisLine) // only one assignment indent per line
{
// register indent at previous word
haveAssignmentThisLine = true;
int prevWordIndex = getInStatementIndentAssign(line, i);
int inStatementIndent = prevWordIndex + spaceIndentCount + tabIncrementIn;
inStatementIndentStack->push_back(inStatementIndent);
}
}
else
{
if (i == 0 && spaceIndentCount == 0)
spaceIndentCount += indentLength;
registerInStatementIndent(line, i, spaceIndentCount, tabIncrementIn, 0, false);
}
isInStatement = true;
}
}
}
} // end of for loop * end of for loop * end of for loop * end of for loop * end of for loop *
}
} // end namespace astyle
astyle/src/ASEnhancer.cpp 100777 0 0 44145 12235007664 10775 0 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* ASEnhancer.cpp
*
* Copyright (C) 2006-2013 by Jim Pattee
* Copyright (C) 1998-2002 by Tal Davidson
*
*
* This file is a part of Artistic Style - an indentation and
* reformatting tool for C, C++, C# and Java source files.
*
*
* Artistic Style is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Artistic Style is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Artistic Style. If not, see .
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*/
#include "astyle.h"
namespace astyle {
/**
* ASEnhancer constructor
*/
ASEnhancer::ASEnhancer()
{
}
/**
* Destructor of ASEnhancer
*/
ASEnhancer::~ASEnhancer()
{
}
/**
* initialize the ASEnhancer.
*
* init() is called each time an ASFormatter object is initialized.
*/
void ASEnhancer::init(int _fileType,
int _indentLength,
int _tabLength,
bool _useTabs,
bool _forceTab,
bool _caseIndent,
bool _preprocessorIndent,
bool _emptyLineFill)
{
// formatting variables from ASFormatter and ASBeautifier
ASBase::init(_fileType);
indentLength = _indentLength;
tabLength = _tabLength;
useTabs = _useTabs;
forceTab = _forceTab;
caseIndent = _caseIndent;
preprocessorIndent = _preprocessorIndent;
emptyLineFill = _emptyLineFill;
quoteChar = '\'';
// unindent variables
lineNumber = 0;
bracketCount = 0;
isInComment = false;
isInQuote = false;
switchDepth = 0;
lookingForCaseBracket = false;
unindentNextLine = false;
shouldUnindentLine = false;
shouldUnindentComment = false;
// switch struct and vector
sw.switchBracketCount = 0;
sw.unindentDepth = 0;
sw.unindentCase = false;
switchStack.clear();
// other variables
nextLineIsEventIndent = false;
isInEventTable = false;
nextLineIsDeclareIndent = false;
isInDeclareSection = false;
}
/**
* additional formatting for line of source code.
* every line of source code in a source code file should be sent
* one after the other to this function.
* indents event tables
* unindents the case blocks
*
* @param line the original formatted line will be updated if necessary.
*/
void ASEnhancer::enhance(string &line, bool isInPreprocessor, bool isInSQL)
{
shouldUnindentLine = true;
shouldUnindentComment = false;
lineNumber++;
// check for beginning of event table
if (nextLineIsEventIndent)
{
isInEventTable = true;
nextLineIsEventIndent = false;
}
// check for beginning of SQL declare section
if (nextLineIsDeclareIndent)
{
isInDeclareSection = true;
nextLineIsDeclareIndent = false;
}
if (line.length() == 0
&& ! isInEventTable
&& ! isInDeclareSection
&& ! emptyLineFill)
return;
// test for unindent on attached brackets
if (unindentNextLine)
{
sw.unindentDepth++;
sw.unindentCase = true;
unindentNextLine = false;
}
// parse characters in the current line
parseCurrentLine(line, isInPreprocessor, isInSQL);
if (isInEventTable || isInDeclareSection)
{
if (line.length() == 0 || line[0] != '#')
indentLine(line, 1);
}
if (shouldUnindentComment && sw.unindentDepth > 0)
unindentLine(line, sw.unindentDepth - 1);
else if (shouldUnindentLine && sw.unindentDepth > 0)
unindentLine(line, sw.unindentDepth);
}
/**
* convert a force-tab indent to spaces
*
* @param line a reference to the line that will be converted.
*/
void ASEnhancer::convertForceTabIndentToSpaces(string &line) const
{
// replace tab indents with spaces
for (size_t i = 0; i < line.length(); i++)
{
if (!isWhiteSpace(line[i]))
break;
if (line[i] == '\t')
{
line.erase(i, 1);
line.insert(i, tabLength, ' ');
i += tabLength - 1;
}
}
}
/**
* convert a space indent to force-tab
*
* @param line a reference to the line that will be converted.
*/
void ASEnhancer::convertSpaceIndentToForceTab(string &line) const
{
assert(tabLength > 0);
// replace leading spaces with tab indents
size_t newSpaceIndentLength = line.find_first_not_of(" \t");
size_t tabCount = newSpaceIndentLength / tabLength; // truncate extra spaces
line.erase(0U, tabCount * tabLength);
line.insert(0U, tabCount, '\t');
}
/**
* find the colon following a 'case' statement
*
* @param line a reference to the line.
* @param i the line index of the case statement.
* @return the line index of the colon.
*/
size_t ASEnhancer::findCaseColon(string &line, size_t caseIndex) const
{
size_t i = caseIndex;
bool isInQuote_ = false;
char quoteChar_ = ' ';
for (; i < line.length(); i++)
{
if (isInQuote_)
{
if (line[i] == '\\')
{
i++;
continue;
}
else if (line[i] == quoteChar_) // check ending quote
{
isInQuote_ = false;
quoteChar_ = ' ';
continue;
}
else
{
continue; // must close quote before continuing
}
}
if (line[i] == '\'' || line[i] == '\"') // check opening quote
{
isInQuote_ = true;
quoteChar_ = line[i];
continue;
}
if (line[i] == ':')
{
if ((i + 1 < line.length()) && (line[i + 1] == ':'))
i++; // bypass scope resolution operator
else
break; // found it
}
}
return i;
}
/**
* indent a line by a given number of tabsets
* by inserting leading whitespace to the line argument.
*
* @param line a reference to the line to indent.
* @param indent the number of tabsets to insert.
* @return the number of characters inserted.
*/
int ASEnhancer::indentLine(string &line, int indent) const
{
if (line.length() == 0
&& ! emptyLineFill)
return 0;
size_t charsToInsert;
if (forceTab && indentLength != tabLength)
{
// replace tab indents with spaces
convertForceTabIndentToSpaces(line);
// insert the space indents
charsToInsert = indent * indentLength;
line.insert(0U, charsToInsert, ' ');
// replace leading spaces with tab indents
convertSpaceIndentToForceTab(line);
}
else if (useTabs)
{
charsToInsert = indent;
line.insert(0U, charsToInsert, '\t');
}
else // spaces
{
charsToInsert = indent * indentLength;
line.insert(0U, charsToInsert, ' ');
}
return charsToInsert;
}
/**
* check for SQL "BEGIN DECLARE SECTION".
* must compare case insensitive and allow any spacing between words.
*
* @param line a reference to the line to indent.
* @param index the current line index.
* @return true if a hit.
*/
bool ASEnhancer::isBeginDeclareSectionSQL(string &line, size_t index) const
{
string word;
size_t hits = 0;
size_t i;
for (i = index; i < line.length(); i++)
{
i = line.find_first_not_of(" \t", i);
if (i == string::npos)
return false;
if (line[i] == ';')
break;
if (!isCharPotentialHeader(line, i))
continue;
word = getCurrentWord(line, i);
for (size_t j = 0; j < word.length(); j++)
word[j] = (char) toupper(word[j]);
if (word == "EXEC" || word == "SQL")
{
i += word.length() - 1;
continue;
}
if (word == "DECLARE" || word == "SECTION")
{
hits++;
i += word.length() - 1;
continue;
}
if (word == "BEGIN")
{
hits++;
i += word.length() - 1;
continue;
}
return false;
}
if (hits == 3)
return true;
return false;
}
/**
* check for SQL "END DECLARE SECTION".
* must compare case insensitive and allow any spacing between words.
*
* @param line a reference to the line to indent.
* @param index the current line index.
* @return true if a hit.
*/
bool ASEnhancer::isEndDeclareSectionSQL(string &line, size_t index) const
{
string word;
size_t hits = 0;
size_t i;
for (i = index; i < line.length(); i++)
{
i = line.find_first_not_of(" \t", i);
if (i == string::npos)
return false;
if (line[i] == ';')
break;
if (!isCharPotentialHeader(line, i))
continue;
word = getCurrentWord(line, i);
for (size_t j = 0; j < word.length(); j++)
word[j] = (char) toupper(word[j]);
if (word == "EXEC" || word == "SQL")
{
i += word.length() - 1;
continue;
}
if (word == "DECLARE" || word == "SECTION")
{
hits++;
i += word.length() - 1;
continue;
}
if (word == "END")
{
hits++;
i += word.length() - 1;
continue;
}
return false;
}
if (hits == 3)
return true;
return false;
}
/**
* check if a one-line bracket has been reached,
* i.e. if the currently reached '{' character is closed
* with a complimentry '}' elsewhere on the current line,
*.
* @return false = one-line bracket has not been reached.
* true = one-line bracket has been reached.
*/
bool ASEnhancer::isOneLineBlockReached(string &line, int startChar) const
{
assert(line[startChar] == '{');
bool isInComment_ = false;
bool isInQuote_ = false;
int _bracketCount = 1;
int lineLength = line.length();
char quoteChar_ = ' ';
char ch = ' ';
for (int i = startChar + 1; i < lineLength; ++i)
{
ch = line[i];
if (isInComment_)
{
if (line.compare(i, 2, "*/") == 0)
{
isInComment_ = false;
++i;
}
continue;
}
if (ch == '\\')
{
++i;
continue;
}
if (isInQuote_)
{
if (ch == quoteChar_)
isInQuote_ = false;
continue;
}
if (ch == '"' || ch == '\'')
{
isInQuote_ = true;
quoteChar_ = ch;
continue;
}
if (line.compare(i, 2, "//") == 0)
break;
if (line.compare(i, 2, "/*") == 0)
{
isInComment_ = true;
++i;
continue;
}
if (ch == '{')
++_bracketCount;
else if (ch == '}')
--_bracketCount;
if (_bracketCount == 0)
return true;
}
return false;
}
/**
* parse characters in the current line to determine if an indent
* or unindent is needed.
*/
void ASEnhancer::parseCurrentLine(string &line, bool isInPreprocessor, bool isInSQL)
{
bool isSpecialChar = false; // is a backslash escape character
for (size_t i = 0; i < line.length(); i++)
{
char ch = line[i];
// bypass whitespace
if (isWhiteSpace(ch))
continue;
// handle special characters (i.e. backslash+character such as \n, \t, ...)
if (isSpecialChar)
{
isSpecialChar = false;
continue;
}
if (!(isInComment) && line.compare(i, 2, "\\\\") == 0)
{
i++;
continue;
}
if (!(isInComment) && ch == '\\')
{
isSpecialChar = true;
continue;
}
// handle quotes (such as 'x' and "Hello Dolly")
if (!isInComment && (ch == '"' || ch == '\''))
{
if (!isInQuote)
{
quoteChar = ch;
isInQuote = true;
}
else if (quoteChar == ch)
{
isInQuote = false;
continue;
}
}
if (isInQuote)
continue;
// handle comments
if (!(isInComment) && line.compare(i, 2, "//") == 0)
{
// check for windows line markers
if (line.compare(i + 2, 1, "\xf0") > 0)
lineNumber--;
// unindent if not in case brackets
if (line.find_first_not_of(" \t") == i
&& sw.switchBracketCount == 1
&& sw.unindentCase)
shouldUnindentComment = true;
break; // finished with the line
}
else if (!(isInComment) && line.compare(i, 2, "/*") == 0)
{
// unindent if not in case brackets
if (sw.switchBracketCount == 1 && sw.unindentCase)
shouldUnindentComment = true;
isInComment = true;
size_t commentEnd = line.find("*/", i);
if (commentEnd == string::npos)
i = line.length() - 1;
else
i = commentEnd - 1;
continue;
}
else if ((isInComment) && line.compare(i, 2, "*/") == 0)
{
// unindent if not in case brackets
if (sw.switchBracketCount == 1 && sw.unindentCase)
shouldUnindentComment = true;
isInComment = false;
i++;
continue;
}
if (isInComment)
{
// unindent if not in case brackets
if (sw.switchBracketCount == 1 && sw.unindentCase)
shouldUnindentComment = true;
size_t commentEnd = line.find("*/", i);
if (commentEnd == string::npos)
i = line.length() - 1;
else
i = commentEnd - 1;
continue;
}
// if we have reached this far then we are NOT in a comment or string of special characters
if (line[i] == '{')
bracketCount++;
if (line[i] == '}')
bracketCount--;
bool isPotentialKeyword = isCharPotentialHeader(line, i);
// ---------------- wxWidgets and MFC macros ----------------------------------
if (isPotentialKeyword)
{
if (findKeyword(line, i, "BEGIN_EVENT_TABLE")
|| findKeyword(line, i, "BEGIN_DISPATCH_MAP")
|| findKeyword(line, i, "BEGIN_EVENT_MAP")
|| findKeyword(line, i, "BEGIN_MESSAGE_MAP")
|| findKeyword(line, i, "BEGIN_PROPPAGEIDS"))
{
nextLineIsEventIndent = true;
break;
}
if (findKeyword(line, i, "END_EVENT_TABLE")
|| findKeyword(line, i, "END_DISPATCH_MAP")
|| findKeyword(line, i, "END_EVENT_MAP")
|| findKeyword(line, i, "END_MESSAGE_MAP")
|| findKeyword(line, i, "END_PROPPAGEIDS"))
{
isInEventTable = false;
break;
}
}
// ---------------- process SQL -----------------------------------------------
if (isInSQL)
{
if (isBeginDeclareSectionSQL(line, i))
nextLineIsDeclareIndent = true;
if (isEndDeclareSectionSQL(line, i))
isInDeclareSection = false;
break;
}
// ---------------- process switch statements ---------------------------------
if (isPotentialKeyword && findKeyword(line, i, "switch"))
{
switchDepth++;
switchStack.push_back(sw); // save current variables
sw.switchBracketCount = 0;
sw.unindentCase = false; // don't clear case until end of switch
i += 5; // bypass switch statement
continue;
}
// just want unindented case statements from this point
if (caseIndent
|| switchDepth == 0
|| (isInPreprocessor && !preprocessorIndent))
{
// bypass the entire word
if (isPotentialKeyword)
{
string name = getCurrentWord(line, i);
i += name.length() - 1;
}
continue;
}
i = processSwitchBlock(line, i);
} // end of for loop * end of for loop * end of for loop * end of for loop
}
/**
* process the character at the current index in a switch block.
*
* @param line a reference to the line to indent.
* @param index the current line index.
* @return the new line index.
*/
size_t ASEnhancer::processSwitchBlock(string &line, size_t index)
{
size_t i = index;
bool isPotentialKeyword = isCharPotentialHeader(line, i);
if (line[i] == '{')
{
sw.switchBracketCount++;
if (lookingForCaseBracket) // if 1st after case statement
{
sw.unindentCase = true; // unindenting this case
sw.unindentDepth++;
lookingForCaseBracket = false; // not looking now
}
return i;
}
lookingForCaseBracket = false; // no opening bracket, don't indent
if (line[i] == '}')
{
sw.switchBracketCount--;
assert(sw.switchBracketCount <= bracketCount);
if (sw.switchBracketCount == 0) // if end of switch statement
{
int lineUnindent = sw.unindentDepth;
if (line.find_first_not_of(" \t") == i
&& !switchStack.empty())
lineUnindent = switchStack[switchStack.size() - 1].unindentDepth;
if (shouldUnindentLine)
{
if (lineUnindent > 0)
i -= unindentLine(line, lineUnindent);
shouldUnindentLine = false;
}
switchDepth--;
sw = switchStack.back();
switchStack.pop_back();
}
return i;
}
if (isPotentialKeyword
&& (findKeyword(line, i, "case") || findKeyword(line, i, "default")))
{
if (sw.unindentCase) // if unindented last case
{
sw.unindentCase = false; // stop unindenting previous case
sw.unindentDepth--;
}
i = findCaseColon(line, i);
i++;
for (; i < line.length(); i++) // bypass whitespace
{
if (!isWhiteSpace(line[i]))
break;
}
if (i < line.length())
{
if (line[i] == '{')
{
bracketCount++;
sw.switchBracketCount++;
if (!isOneLineBlockReached(line, i))
unindentNextLine = true;
return i;
}
}
lookingForCaseBracket = true;
i--; // need to process this char
return i;
}
if (isPotentialKeyword)
{
string name = getCurrentWord(line, i); // bypass the entire name
i += name.length() - 1;
}
return i;
}
/**
* unindent a line by a given number of tabsets
* by erasing the leading whitespace from the line argument.
*
* @param line a reference to the line to unindent.
* @param unindent the number of tabsets to erase.
* @return the number of characters erased.
*/
int ASEnhancer::unindentLine(string &line, int unindent) const
{
size_t whitespace = line.find_first_not_of(" \t");
if (whitespace == string::npos) // if line is blank
whitespace = line.length(); // must remove padding, if any
if (whitespace == 0)
return 0;
size_t charsToErase = 0;
if (forceTab && indentLength != tabLength)
{
// replace tab indents with spaces
convertForceTabIndentToSpaces(line);
// remove the space indents
size_t spaceIndentLength = line.find_first_not_of(" \t");
charsToErase = unindent * indentLength;
if (charsToErase <= spaceIndentLength)
line.erase(0, charsToErase);
else
charsToErase = 0;
// replace leading spaces with tab indents
convertSpaceIndentToForceTab(line);
}
else if (useTabs)
{
charsToErase = unindent;
if (charsToErase <= whitespace)
line.erase(0, charsToErase);
else
charsToErase = 0;
}
else // spaces
{
charsToErase = unindent * indentLength;
if (charsToErase <= whitespace)
line.erase(0, charsToErase);
else
charsToErase = 0;
}
return charsToErase;
}
} // end namespace astyle
astyle/src/ASFormatter.cpp 100777 0 0 563243 12235007664 11242 0 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* ASFormatter.cpp
*
* Copyright (C) 2006-2013 by Jim Pattee
* Copyright (C) 1998-2002 by Tal Davidson
*
*
* This file is a part of Artistic Style - an indentation and
* reformatting tool for C, C++, C# and Java source files.
*
*
* Artistic Style is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Artistic Style is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Artistic Style. If not, see .
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*/
#include "astyle.h"
#include
#include
namespace astyle {
/**
* Constructor of ASFormatter
*/
ASFormatter::ASFormatter()
{
sourceIterator = NULL;
enhancer = new ASEnhancer;
preBracketHeaderStack = NULL;
bracketTypeStack = NULL;
parenStack = NULL;
structStack = NULL;
questionMarkStack = NULL;
lineCommentNoIndent = false;
formattingStyle = STYLE_NONE;
bracketFormatMode = NONE_MODE;
pointerAlignment = PTR_ALIGN_NONE;
referenceAlignment = REF_SAME_AS_PTR;
objCColonPadMode = COLON_PAD_NO_CHANGE;
lineEnd = LINEEND_DEFAULT;
maxCodeLength = string::npos;
shouldPadOperators = false;
shouldPadParensOutside = false;
shouldPadFirstParen = false;
shouldPadParensInside = false;
shouldPadHeader = false;
shouldStripCommentPrefix = false;
shouldUnPadParens = false;
shouldAttachClosingBracket = false;
shouldBreakOneLineBlocks = true;
shouldBreakOneLineStatements = true;
shouldConvertTabs = false;
shouldIndentCol1Comments = false;
shouldCloseTemplates = false;
shouldAttachExternC = false;
shouldAttachNamespace = false;
shouldAttachClass = false;
shouldAttachInline = false;
shouldBreakBlocks = false;
shouldBreakClosingHeaderBlocks = false;
shouldBreakClosingHeaderBrackets = false;
shouldDeleteEmptyLines = false;
shouldBreakElseIfs = false;
shouldBreakLineAfterLogical = false;
shouldAddBrackets = false;
shouldAddOneLineBrackets = false;
shouldRemoveBrackets = false;
shouldPadMethodColon = false;
shouldPadMethodPrefix = false;
shouldUnPadMethodPrefix = false;
// initialize ASFormatter member vectors
formatterFileType = 9; // reset to an invalid type
headers = new vector;
nonParenHeaders = new vector;
preDefinitionHeaders = new vector;
preCommandHeaders = new vector;
operators = new vector;
assignmentOperators = new vector;
castOperators = new vector;
}
/**
* Destructor of ASFormatter
*/
ASFormatter::~ASFormatter()
{
// delete ASFormatter stack vectors
deleteContainer(preBracketHeaderStack);
deleteContainer(bracketTypeStack);
deleteContainer(parenStack);
deleteContainer(structStack);
deleteContainer(questionMarkStack);
// delete ASFormatter member vectors
formatterFileType = 9; // reset to an invalid type
delete headers;
delete nonParenHeaders;
delete preDefinitionHeaders;
delete preCommandHeaders;
delete operators;
delete assignmentOperators;
delete castOperators;
// delete ASBeautifier member vectors
// must be done when the ASFormatter object is deleted (not ASBeautifier)
ASBeautifier::deleteBeautifierVectors();
delete enhancer;
}
/**
* initialize the ASFormatter.
*
* init() should be called every time a ASFormatter object is to start
* formatting a NEW source file.
* init() receives a pointer to a ASSourceIterator object that will be
* used to iterate through the source code.
*
* @param sourceIterator a pointer to the ASSourceIterator or ASStreamIterator object.
*/
void ASFormatter::init(ASSourceIterator* si)
{
buildLanguageVectors();
fixOptionVariableConflicts();
ASBeautifier::init(si);
enhancer->init(getFileType(),
getIndentLength(),
getTabLength(),
getIndentString() == "\t" ? true : false,
getForceTabIndentation(),
getCaseIndent(),
getPreprocDefineIndent(),
getEmptyLineFill());
sourceIterator = si;
initContainer(preBracketHeaderStack, new vector);
initContainer(parenStack, new vector);
initContainer(structStack, new vector);
initContainer(questionMarkStack, new vector);
parenStack->push_back(0); // parenStack must contain this default entry
initContainer(bracketTypeStack, new vector);
bracketTypeStack->push_back(NULL_TYPE); // bracketTypeStack must contain this default entry
clearFormattedLineSplitPoints();
currentHeader = NULL;
currentLine = "";
readyFormattedLine = "";
formattedLine = "";
currentChar = ' ';
previousChar = ' ';
previousCommandChar = ' ';
previousNonWSChar = ' ';
quoteChar = '"';
charNum = 0;
checksumIn = 0;
checksumOut = 0;
currentLineFirstBracketNum = string::npos;
formattedLineCommentNum = 0;
leadingSpaces = 0;
previousReadyFormattedLineLength = string::npos;
preprocBracketTypeStackSize = 0;
spacePadNum = 0;
nextLineSpacePadNum = 0;
templateDepth = 0;
traceLineNumber = 0;
squareBracketCount = 0;
horstmannIndentChars = 0;
tabIncrementIn = 0;
previousBracketType = NULL_TYPE;
previousOperator = NULL;
isVirgin = true;
isInLineComment = false;
isInComment = false;
isInCommentStartLine = false;
noTrimCommentContinuation = false;
isInPreprocessor = false;
isInPreprocessorBeautify = false;
doesLineStartComment = false;
lineEndsInCommentOnly = false;
lineIsLineCommentOnly = false;
lineIsEmpty = false;
isImmediatelyPostCommentOnly = false;
isImmediatelyPostEmptyLine = false;
isInQuote = false;
isInVerbatimQuote = false;
haveLineContinuationChar = false;
isInQuoteContinuation = false;
isHeaderInMultiStatementLine = false;
isSpecialChar = false;
isNonParenHeader = false;
foundNamespaceHeader = false;
foundClassHeader = false;
foundStructHeader = false;
foundInterfaceHeader = false;
foundPreDefinitionHeader = false;
foundPreCommandHeader = false;
foundPreCommandMacro = false;
foundCastOperator = false;
foundQuestionMark = false;
isInLineBreak = false;
endOfAsmReached = false;
endOfCodeReached = false;
isInEnum = false;
isInExecSQL = false;
isInAsm = false;
isInAsmOneLine = false;
isInAsmBlock = false;
isLineReady = false;
elseHeaderFollowsComments = false;
caseHeaderFollowsComments = false;
isPreviousBracketBlockRelated = false;
isInPotentialCalculation = false;
shouldReparseCurrentChar = false;
needHeaderOpeningBracket = false;
shouldBreakLineAtNextChar = false;
shouldKeepLineUnbroken = false;
passedSemicolon = false;
passedColon = false;
isImmediatelyPostNonInStmt = false;
isCharImmediatelyPostNonInStmt = false;
isInTemplate = false;
isImmediatelyPostComment = false;
isImmediatelyPostLineComment = false;
isImmediatelyPostEmptyBlock = false;
isImmediatelyPostPreprocessor = false;
isImmediatelyPostReturn = false;
isImmediatelyPostThrow = false;
isImmediatelyPostOperator = false;
isImmediatelyPostTemplate = false;
isImmediatelyPostPointerOrReference = false;
isCharImmediatelyPostReturn = false;
isCharImmediatelyPostThrow = false;
isCharImmediatelyPostOperator = false;
isCharImmediatelyPostComment = false;
isPreviousCharPostComment = false;
isCharImmediatelyPostLineComment = false;
isCharImmediatelyPostOpenBlock = false;
isCharImmediatelyPostCloseBlock = false;
isCharImmediatelyPostTemplate = false;
isCharImmediatelyPostPointerOrReference = false;
isInObjCMethodDefinition = false;
isInObjCInterface = false;
isInObjCSelector = false;
breakCurrentOneLineBlock = false;
shouldRemoveNextClosingBracket = false;
isInHorstmannRunIn = false;
currentLineBeginsWithBracket = false;
isPrependPostBlockEmptyLineRequested = false;
isAppendPostBlockEmptyLineRequested = false;
prependEmptyLine = false;
appendOpeningBracket = false;
foundClosingHeader = false;
isImmediatelyPostHeader = false;
isInHeader = false;
isInCase = false;
isJavaStaticConstructor = false;
}
/**
* build vectors for each programing language
* depending on the file extension.
*/
void ASFormatter::buildLanguageVectors()
{
if (getFileType() == formatterFileType) // don't build unless necessary
return;
formatterFileType = getFileType();
headers->clear();
nonParenHeaders->clear();
preDefinitionHeaders->clear();
preCommandHeaders->clear();
operators->clear();
assignmentOperators->clear();
castOperators->clear();
ASResource::buildHeaders(headers, getFileType());
ASResource::buildNonParenHeaders(nonParenHeaders, getFileType());
ASResource::buildPreDefinitionHeaders(preDefinitionHeaders, getFileType());
ASResource::buildPreCommandHeaders(preCommandHeaders, getFileType());
if (operators->empty())
ASResource::buildOperators(operators, getFileType());
if (assignmentOperators->empty())
ASResource::buildAssignmentOperators(assignmentOperators);
if (castOperators->empty())
ASResource::buildCastOperators(castOperators);
}
/**
* set the variables for each predefined style.
* this will override any previous settings.
*/
void ASFormatter::fixOptionVariableConflicts()
{
if (formattingStyle == STYLE_ALLMAN)
{
setBracketFormatMode(BREAK_MODE);
}
else if (formattingStyle == STYLE_JAVA)
{
setBracketFormatMode(ATTACH_MODE);
}
else if (formattingStyle == STYLE_KR)
{
setBracketFormatMode(LINUX_MODE);
}
else if (formattingStyle == STYLE_STROUSTRUP)
{
setBracketFormatMode(STROUSTRUP_MODE);
}
else if (formattingStyle == STYLE_WHITESMITH)
{
setBracketFormatMode(BREAK_MODE);
setBracketIndent(true);
setClassIndent(true);
setSwitchIndent(true);
}
else if (formattingStyle == STYLE_BANNER)
{
setBracketFormatMode(ATTACH_MODE);
setBracketIndent(true);
setClassIndent(true);
setSwitchIndent(true);
}
else if (formattingStyle == STYLE_GNU)
{
setBracketFormatMode(BREAK_MODE);
setBlockIndent(true);
}
else if (formattingStyle == STYLE_LINUX)
{
setBracketFormatMode(LINUX_MODE);
// always for Linux style
setMinConditionalIndentOption(MINCOND_ONEHALF);
}
else if (formattingStyle == STYLE_HORSTMANN)
{
setBracketFormatMode(RUN_IN_MODE);
setSwitchIndent(true);
}
else if (formattingStyle == STYLE_1TBS)
{
setBracketFormatMode(LINUX_MODE);
setAddBracketsMode(true);
setRemoveBracketsMode(false);
}
else if (formattingStyle == STYLE_GOOGLE)
{
setBracketFormatMode(ATTACH_MODE);
setModifierIndent(true);
setClassIndent(false);
}
else if (formattingStyle == STYLE_PICO)
{
setBracketFormatMode(RUN_IN_MODE);
setAttachClosingBracket(true);
setSwitchIndent(true);
setBreakOneLineBlocksMode(false);
setSingleStatementsMode(false);
// add-brackets won't work for pico, but it could be fixed if necessary
// both options should be set to true
if (shouldAddBrackets)
shouldAddOneLineBrackets = true;
}
else if (formattingStyle == STYLE_LISP)
{
setBracketFormatMode(ATTACH_MODE);
setAttachClosingBracket(true);
setSingleStatementsMode(false);
// add-one-line-brackets won't work for lisp
// only shouldAddBrackets should be set to true
if (shouldAddOneLineBrackets)
{
shouldAddBrackets = true;
shouldAddOneLineBrackets = false;
}
}
setMinConditionalIndentLength();
// if not set by indent=force-tab-x set equal to indentLength
if (!getTabLength())
setDefaultTabLength();
// add-one-line-brackets implies keep-one-line-blocks
if (shouldAddOneLineBrackets)
setBreakOneLineBlocksMode(false);
// don't allow add-brackets and remove-brackets
if (shouldAddBrackets || shouldAddOneLineBrackets)
setRemoveBracketsMode(false);
// don't allow indent-classes and indent-modifiers
if (getClassIndent())
setModifierIndent(false);
}
/**
* get the next formatted line.
*
* @return formatted line.
*/
string ASFormatter::nextLine()
{
const string* newHeader;
bool isInVirginLine = isVirgin;
isCharImmediatelyPostComment = false;
isPreviousCharPostComment = false;
isCharImmediatelyPostLineComment = false;
isCharImmediatelyPostOpenBlock = false;
isCharImmediatelyPostCloseBlock = false;
isCharImmediatelyPostTemplate = false;
traceLineNumber++;
while (!isLineReady)
{
if (shouldReparseCurrentChar)
shouldReparseCurrentChar = false;
else if (!getNextChar())
{
breakLine();
continue;
}
else // stuff to do when reading a new character...
{
// make sure that a virgin '{' at the beginning of the file will be treated as a block...
if (isInVirginLine && currentChar == '{'
&& currentLineBeginsWithBracket
&& previousCommandChar == ' ')
previousCommandChar = '{';
if (isInHorstmannRunIn)
isInLineBreak = false;
if (!isWhiteSpace(currentChar))
isInHorstmannRunIn = false;
isPreviousCharPostComment = isCharImmediatelyPostComment;
isCharImmediatelyPostComment = false;
isCharImmediatelyPostTemplate = false;
isCharImmediatelyPostReturn = false;
isCharImmediatelyPostThrow = false;
isCharImmediatelyPostOperator = false;
isCharImmediatelyPostPointerOrReference = false;
isCharImmediatelyPostOpenBlock = false;
isCharImmediatelyPostCloseBlock = false;
}
if (shouldBreakLineAtNextChar)
{
if (isWhiteSpace(currentChar) && !lineIsEmpty)
continue;
isInLineBreak = true;
shouldBreakLineAtNextChar = false;
}
if (isInExecSQL && !passedSemicolon)
{
if (currentChar == ';')
passedSemicolon = true;
appendCurrentChar();
continue;
}
if (isInLineComment)
{
formatLineCommentBody();
continue;
}
else if (isInComment)
{
formatCommentBody();
continue;
}
else if (isInQuote)
{
formatQuoteBody();
continue;
}
// not in quote or comment or line comment
if (isSequenceReached("//"))
{
formatLineCommentOpener();
testForTimeToSplitFormattedLine();
continue;
}
else if (isSequenceReached("/*"))
{
formatCommentOpener();
testForTimeToSplitFormattedLine();
continue;
}
else if (currentChar == '"' || currentChar == '\'')
{
formatQuoteOpener();
testForTimeToSplitFormattedLine();
continue;
}
// treat these preprocessor statements as a line comment
else if (currentChar == '#'
&& currentLine.find_first_not_of(" \t") == (size_t) charNum)
{
string preproc = trim(currentLine.c_str() + charNum + 1);
if (preproc.length() > 0
&& isCharPotentialHeader(preproc, 0)
&& (findKeyword(preproc, 0, "region")
|| findKeyword(preproc, 0, "endregion")
|| findKeyword(preproc, 0, "error")
|| findKeyword(preproc, 0, "warning")
|| findKeyword(preproc, 0, "line")))
{
currentLine = rtrim(currentLine); // trim the end only
// check for horstmann run-in
if (formattedLine.length() > 0 && formattedLine[0] == '{')
{
isInLineBreak = true;
isInHorstmannRunIn = false;
}
if (previousCommandChar == '}')
currentHeader = NULL;
isInLineComment = true;
appendCurrentChar();
continue;
}
}
if (isInPreprocessor)
{
appendCurrentChar();
continue;
}
if (isInTemplate && shouldCloseTemplates)
{
if (previousCommandChar == '<' && isWhiteSpace(currentChar))
continue;
if (isWhiteSpace(currentChar) && peekNextChar() == '>')
continue;
}
if (shouldRemoveNextClosingBracket && currentChar == '}')
{
currentLine[charNum] = currentChar = ' ';
shouldRemoveNextClosingBracket = false;
assert(adjustChecksumIn(-'}'));
// if the line is empty, delete it
if (currentLine.find_first_not_of(" \t"))
continue;
}
// handle white space - needed to simplify the rest.
if (isWhiteSpace(currentChar))
{
appendCurrentChar();
continue;
}
/* not in MIDDLE of quote or comment or SQL or white-space of any type ... */
// check if in preprocessor
// ** isInPreprocessor will be automatically reset at the beginning
// of a new line in getnextChar()
if (currentChar == '#')
{
isInPreprocessor = true;
// check for horstmann run-in
if (formattedLine.length() > 0 && formattedLine[0] == '{')
{
isInLineBreak = true;
isInHorstmannRunIn = false;
}
processPreprocessor();
// need to fall thru here to reset the variables
}
/* not in preprocessor ... */
if (isImmediatelyPostComment)
{
caseHeaderFollowsComments = false;
isImmediatelyPostComment = false;
isCharImmediatelyPostComment = true;
}
if (isImmediatelyPostLineComment)
{
caseHeaderFollowsComments = false;
isImmediatelyPostLineComment = false;
isCharImmediatelyPostLineComment = true;
}
if (isImmediatelyPostReturn)
{
isImmediatelyPostReturn = false;
isCharImmediatelyPostReturn = true;
}
if (isImmediatelyPostThrow)
{
isImmediatelyPostThrow = false;
isCharImmediatelyPostThrow = true;
}
if (isImmediatelyPostOperator)
{
isImmediatelyPostOperator = false;
isCharImmediatelyPostOperator = true;
}
if (isImmediatelyPostTemplate)
{
isImmediatelyPostTemplate = false;
isCharImmediatelyPostTemplate = true;
}
if (isImmediatelyPostPointerOrReference)
{
isImmediatelyPostPointerOrReference = false;
isCharImmediatelyPostPointerOrReference = true;
}
// reset isImmediatelyPostHeader information
if (isImmediatelyPostHeader)
{
// should brackets be added
if (currentChar != '{' && shouldAddBrackets)
{
bool bracketsAdded = addBracketsToStatement();
if (bracketsAdded && !shouldAddOneLineBrackets)
{
size_t firstText = currentLine.find_first_not_of(" \t");
assert(firstText != string::npos);
if ((int) firstText == charNum)
breakCurrentOneLineBlock = true;
}
}
// should brackets be removed
else if (currentChar == '{' && shouldRemoveBrackets)
{
bool bracketsRemoved = removeBracketsFromStatement();
if (bracketsRemoved)
{
shouldRemoveNextClosingBracket = true;
if (isBeforeAnyLineEndComment(charNum))
spacePadNum--;
else if (shouldBreakOneLineBlocks
|| (currentLineBeginsWithBracket
&& currentLine.find_first_not_of(" \t") != string::npos))
shouldBreakLineAtNextChar = true;
continue;
}
}
// break 'else-if' if shouldBreakElseIfs is requested
if (shouldBreakElseIfs
&& currentHeader == &AS_ELSE
&& isOkToBreakBlock(bracketTypeStack->back())
&& !isBeforeAnyComment()
&& (shouldBreakOneLineStatements || !isHeaderInMultiStatementLine))
{
string nextText = peekNextText(currentLine.substr(charNum));
if (nextText.length() > 0
&& isCharPotentialHeader(nextText, 0)
&& ASBeautifier::findHeader(nextText, 0, headers) == &AS_IF)
{
isInLineBreak = true;
}
}
isImmediatelyPostHeader = false;
}
if (passedSemicolon) // need to break the formattedLine
{
passedSemicolon = false;
if (parenStack->back() == 0 && !isCharImmediatelyPostComment && currentChar != ';') // allow ;;
{
// does a one-line block have ending comments?
if (isBracketType(bracketTypeStack->back(), SINGLE_LINE_TYPE))
{
size_t blockEnd = currentLine.rfind(AS_CLOSE_BRACKET);
assert(blockEnd != string::npos);
// move ending comments to this formattedLine
if (isBeforeAnyLineEndComment(blockEnd))
{
size_t commentStart = currentLine.find_first_not_of(" \t", blockEnd + 1);
assert(commentStart != string::npos);
assert((currentLine.compare(commentStart, 2, "//") == 0)
|| (currentLine.compare(commentStart, 2, "/*") == 0));
size_t commentLength = currentLine.length() - commentStart;
formattedLine.append(getIndentLength() - 1, ' ');
formattedLine.append(currentLine, commentStart, commentLength);
currentLine.erase(commentStart, commentLength);
testForTimeToSplitFormattedLine();
}
}
isInExecSQL = false;
shouldReparseCurrentChar = true;
if (formattedLine.find_first_not_of(" \t") != string::npos)
isInLineBreak = true;
if (needHeaderOpeningBracket)
{
isCharImmediatelyPostCloseBlock = true;
needHeaderOpeningBracket = false;
}
continue;
}
}
if (passedColon)
{
passedColon = false;
if (parenStack->back() == 0
&& !isBeforeAnyComment()
&& (formattedLine.find_first_not_of(" \t") != string::npos))
{
shouldReparseCurrentChar = true;
isInLineBreak = true;
continue;
}
}
// Check if in template declaration, e.g. foo or foo
if (!isInTemplate && currentChar == '<')
{
checkIfTemplateOpener();
}
// handle parenthesies
if (currentChar == '(' || currentChar == '[' || (isInTemplate && currentChar == '<'))
{
questionMarkStack->push_back(foundQuestionMark);
foundQuestionMark = false;
parenStack->back()++;
if (currentChar == '[')
++squareBracketCount;
}
else if (currentChar == ')' || currentChar == ']' || (isInTemplate && currentChar == '>'))
{
foundPreCommandHeader = false;
parenStack->back()--;
// this can happen in preprocessor directives
if (parenStack->back() < 0)
parenStack->back() = 0;
if (!questionMarkStack->empty())
{
foundQuestionMark = questionMarkStack->back();
questionMarkStack->pop_back();
}
if (isInTemplate && currentChar == '>')
{
templateDepth--;
if (templateDepth == 0)
{
isInTemplate = false;
isImmediatelyPostTemplate = true;
}
}
// check if this parenthesis closes a header, e.g. if (...), while (...)
if (isInHeader && parenStack->back() == 0)
{
isInHeader = false;
isImmediatelyPostHeader = true;
foundQuestionMark = false;
}
if (currentChar == ']')
{
--squareBracketCount;
if (squareBracketCount < 0)
squareBracketCount = 0;
}
if (currentChar == ')')
{
foundCastOperator = false;
if (parenStack->back() == 0)
endOfAsmReached = true;
}
}
// handle brackets
if (currentChar == '{' || currentChar == '}')
{
// if appendOpeningBracket this was already done for the original bracket
if (currentChar == '{' && !appendOpeningBracket)
{
BracketType newBracketType = getBracketType();
foundNamespaceHeader = false;
foundClassHeader = false;
foundStructHeader = false;
foundInterfaceHeader = false;
foundPreDefinitionHeader = false;
foundPreCommandHeader = false;
foundPreCommandMacro = false;
isInPotentialCalculation = false;
isInObjCMethodDefinition = false;
isInObjCInterface = false;
isInEnum = false;
isJavaStaticConstructor = false;
isCharImmediatelyPostNonInStmt = false;
needHeaderOpeningBracket = false;
shouldKeepLineUnbroken = false;
isPreviousBracketBlockRelated = !isBracketType(newBracketType, ARRAY_TYPE);
bracketTypeStack->push_back(newBracketType);
preBracketHeaderStack->push_back(currentHeader);
currentHeader = NULL;
structStack->push_back(isInIndentableStruct);
if (isBracketType(newBracketType, STRUCT_TYPE) && isCStyle())
isInIndentableStruct = isStructAccessModified(currentLine, charNum);
else
isInIndentableStruct = false;
}
// this must be done before the bracketTypeStack is popped
BracketType bracketType = bracketTypeStack->back();
bool isOpeningArrayBracket = (isBracketType(bracketType, ARRAY_TYPE)
&& bracketTypeStack->size() >= 2
&& !isBracketType((*bracketTypeStack)[bracketTypeStack->size() - 2], ARRAY_TYPE)
);
if (currentChar == '}')
{
// if a request has been made to append a post block empty line,
// but the block exists immediately before a closing bracket,
// then there is no need for the post block empty line.
isAppendPostBlockEmptyLineRequested = false;
breakCurrentOneLineBlock = false;
if (isInAsm)
endOfAsmReached = true;
isInAsmOneLine = isInQuote = false;
shouldKeepLineUnbroken = false;
squareBracketCount = 0;
if (bracketTypeStack->size() > 1)
{
previousBracketType = bracketTypeStack->back();
bracketTypeStack->pop_back();
isPreviousBracketBlockRelated = !isBracketType(bracketType, ARRAY_TYPE);
}
else
{
previousBracketType = NULL_TYPE;
isPreviousBracketBlockRelated = false;
}
if (!preBracketHeaderStack->empty())
{
currentHeader = preBracketHeaderStack->back();
preBracketHeaderStack->pop_back();
}
else
currentHeader = NULL;
if (!structStack->empty())
{
isInIndentableStruct = structStack->back();
structStack->pop_back();
}
else
isInIndentableStruct = false;
if (isNonInStatementArray
&& (!isBracketType(bracketTypeStack->back(), ARRAY_TYPE) // check previous bracket
|| peekNextChar() == ';')) // check for "};" added V2.01
isImmediatelyPostNonInStmt = true;
}
// format brackets
appendOpeningBracket = false;
if (isBracketType(bracketType, ARRAY_TYPE))
{
formatArrayBrackets(bracketType, isOpeningArrayBracket);
}
else
{
if (currentChar == '{')
formatOpeningBracket(bracketType);
else
formatClosingBracket(bracketType);
}
continue;
}
if ((((previousCommandChar == '{' && isPreviousBracketBlockRelated)
|| ((previousCommandChar == '}'
&& !isImmediatelyPostEmptyBlock
&& isPreviousBracketBlockRelated
&& !isPreviousCharPostComment // Fixes wrongly appended newlines after '}' immediately after comments
&& peekNextChar() != ' '
&& !isBracketType(previousBracketType, DEFINITION_TYPE))
&& !isBracketType(bracketTypeStack->back(), DEFINITION_TYPE)))
&& isOkToBreakBlock(bracketTypeStack->back()))
// check for array
|| (previousCommandChar == '{' // added 9/30/2010
&& isBracketType(bracketTypeStack->back(), ARRAY_TYPE)
&& !isBracketType(bracketTypeStack->back(), SINGLE_LINE_TYPE)
&& isNonInStatementArray))
{
isCharImmediatelyPostOpenBlock = (previousCommandChar == '{');
isCharImmediatelyPostCloseBlock = (previousCommandChar == '}');
if (isCharImmediatelyPostOpenBlock
&& !isCharImmediatelyPostComment
&& !isCharImmediatelyPostLineComment)
{
previousCommandChar = ' ';
if (bracketFormatMode == NONE_MODE)
{
if (shouldBreakOneLineBlocks
&& isBracketType(bracketTypeStack->back(), SINGLE_LINE_TYPE))
isInLineBreak = true;
else if (currentLineBeginsWithBracket)
formatRunIn();
else
breakLine();
}
else if (bracketFormatMode == RUN_IN_MODE
&& currentChar != '#')
formatRunIn();
else
isInLineBreak = true;
}
else if (isCharImmediatelyPostCloseBlock
&& shouldBreakOneLineStatements
&& (isLegalNameChar(currentChar) && currentChar != '.')
&& !isCharImmediatelyPostComment)
{
previousCommandChar = ' ';
isInLineBreak = true;
}
}
// reset block handling flags
isImmediatelyPostEmptyBlock = false;
// look for headers
bool isPotentialHeader = isCharPotentialHeader(currentLine, charNum);
if (isPotentialHeader && !isInTemplate && !squareBracketCount)
{
isNonParenHeader = false;
foundClosingHeader = false;
newHeader = findHeader(headers);
if (newHeader != NULL)
{
const string* previousHeader;
// recognize closing headers of do..while, if..else, try..catch..finally
if ((newHeader == &AS_ELSE && currentHeader == &AS_IF)
|| (newHeader == &AS_WHILE && currentHeader == &AS_DO)
|| (newHeader == &AS_CATCH && currentHeader == &AS_TRY)
|| (newHeader == &AS_CATCH && currentHeader == &AS_CATCH)
|| (newHeader == &AS_FINALLY && currentHeader == &AS_TRY)
|| (newHeader == &AS_FINALLY && currentHeader == &AS_CATCH)
|| (newHeader == &_AS_FINALLY && currentHeader == &_AS_TRY)
|| (newHeader == &_AS_EXCEPT && currentHeader == &_AS_TRY)
|| (newHeader == &AS_SET && currentHeader == &AS_GET)
|| (newHeader == &AS_REMOVE && currentHeader == &AS_ADD))
foundClosingHeader = true;
previousHeader = currentHeader;
currentHeader = newHeader;
needHeaderOpeningBracket = true;
// is the previous statement on the same line?
if ((previousNonWSChar == ';' || previousNonWSChar == ':')
&& !isInLineBreak
&& isOkToBreakBlock(bracketTypeStack->back()))
{
// if breaking lines, break the line at the header
// except for multiple 'case' statements on a line
if (maxCodeLength != string::npos
&& previousHeader != &AS_CASE)
isInLineBreak = true;
else
isHeaderInMultiStatementLine = true;
}
if (foundClosingHeader && previousNonWSChar == '}')
{
if (isOkToBreakBlock(bracketTypeStack->back()))
isLineBreakBeforeClosingHeader();
// get the adjustment for a comment following the closing header
if (isInLineBreak)
nextLineSpacePadNum = getNextLineCommentAdjustment();
else
spacePadNum = getCurrentLineCommentAdjustment();
}
// check if the found header is non-paren header
isNonParenHeader = findHeader(nonParenHeaders) != NULL;
// join 'else if' statements
if (currentHeader == &AS_IF && previousHeader == &AS_ELSE && isInLineBreak
&& !shouldBreakElseIfs && !isCharImmediatelyPostLineComment)
{
// 'else' must be last thing on the line
size_t start = formattedLine.length() >= 6 ? formattedLine.length() - 6 : 0;
if (formattedLine.find(AS_ELSE, start) != string::npos)
{
appendSpacePad();
isInLineBreak = false;
}
}
appendSequence(*currentHeader);
goForward(currentHeader->length() - 1);
// if a paren-header is found add a space after it, if needed
// this checks currentLine, appendSpacePad() checks formattedLine
// in 'case' and C# 'catch' can be either a paren or non-paren header
if (shouldPadHeader
&& (!isNonParenHeader
|| (currentHeader == &AS_CASE && peekNextChar() == '(')
|| (currentHeader == &AS_CATCH && peekNextChar() == '('))
&& charNum < (int) currentLine.length() - 1 && !isWhiteSpace(currentLine[charNum + 1]))
appendSpacePad();
// Signal that a header has been reached
// *** But treat a closing while() (as in do...while)
// as if it were NOT a header since a closing while()
// should never have a block after it!
if (currentHeader != &AS_CASE && currentHeader != &AS_DEFAULT
&& !(foundClosingHeader && currentHeader == &AS_WHILE))
{
isInHeader = true;
// in C# 'catch' and 'delegate' can be a paren or non-paren header
if (isNonParenHeader && !isSharpStyleWithParen(currentHeader))
{
isImmediatelyPostHeader = true;
isInHeader = false;
}
}
if (shouldBreakBlocks
&& isOkToBreakBlock(bracketTypeStack->back())
&& !isHeaderInMultiStatementLine)
{
if (previousHeader == NULL
&& !foundClosingHeader
&& !isCharImmediatelyPostOpenBlock
&& !isImmediatelyPostCommentOnly)
{
isPrependPostBlockEmptyLineRequested = true;
}
if (currentHeader == &AS_ELSE
|| currentHeader == &AS_CATCH
|| currentHeader == &AS_FINALLY
|| foundClosingHeader)
{
isPrependPostBlockEmptyLineRequested = false;
}
if (shouldBreakClosingHeaderBlocks
&& isCharImmediatelyPostCloseBlock
&& !isImmediatelyPostCommentOnly
&& currentHeader != &AS_WHILE) // closing do-while block
{
isPrependPostBlockEmptyLineRequested = true;
}
}
if (currentHeader == &AS_CASE
|| currentHeader == &AS_DEFAULT)
isInCase = true;
continue;
}
else if ((newHeader = findHeader(preDefinitionHeaders)) != NULL
&& parenStack->back() == 0)
{
if (newHeader == &AS_NAMESPACE)
foundNamespaceHeader = true;
if (newHeader == &AS_CLASS)
foundClassHeader = true;
if (newHeader == &AS_STRUCT)
foundStructHeader = true;
if (newHeader == &AS_INTERFACE)
foundInterfaceHeader = true;
foundPreDefinitionHeader = true;
appendSequence(*newHeader);
goForward(newHeader->length() - 1);
continue;
}
else if ((newHeader = findHeader(preCommandHeaders)) != NULL)
{
foundPreCommandHeader = true;
// fall thru here for a 'const' that is not a precommand header
}
else if ((newHeader = findHeader(castOperators)) != NULL)
{
foundCastOperator = true;
appendSequence(*newHeader);
goForward(newHeader->length() - 1);
continue;
}
} // (isPotentialHeader && !isInTemplate)
if (isInLineBreak) // OK to break line here
{
breakLine();
if (isInVirginLine) // adjust for the first line
{
lineCommentNoBeautify = lineCommentNoIndent;
lineCommentNoIndent = false;
}
}
if (previousNonWSChar == '}' || currentChar == ';')
{
if (currentChar == ';')
{
squareBracketCount = 0;
if (((shouldBreakOneLineStatements
|| isBracketType(bracketTypeStack->back(), SINGLE_LINE_TYPE))
&& isOkToBreakBlock(bracketTypeStack->back()))
&& !(shouldAttachClosingBracket && peekNextChar() == '}'))
{
passedSemicolon = true;
}
// append post block empty line for unbracketed header
if (shouldBreakBlocks
&& currentHeader != NULL
&& currentHeader != &AS_CASE
&& currentHeader != &AS_DEFAULT
&& !isHeaderInMultiStatementLine
&& parenStack->back() == 0)
{
isAppendPostBlockEmptyLineRequested = true;
}
}
if (currentChar != ';'
|| (needHeaderOpeningBracket && parenStack->back() == 0))
currentHeader = NULL;
resetEndOfStatement();
}
if (currentChar == ':')
{
if (isInCase
&& previousChar != ':' // not part of '::'
&& peekNextChar() != ':') // not part of '::'
{
isInCase = false;
if (shouldBreakOneLineStatements)
passedColon = true;
}
else if (isCStyle() // for C/C++ only
&& isOkToBreakBlock(bracketTypeStack->back())
&& shouldBreakOneLineStatements
&& !foundQuestionMark // not in a ?: sequence
&& !foundPreDefinitionHeader // not in a definition block (e.g. class foo : public bar
&& previousCommandChar != ')' // not immediately after closing paren of a method header, e.g. ASFormatter::ASFormatter(...) : ASBeautifier(...)
&& previousChar != ':' // not part of '::'
&& peekNextChar() != ':' // not part of '::'
&& !squareBracketCount // not in objC method call
&& !isInObjCMethodDefinition // not objC '-' or '+' method
&& !isInObjCInterface // not objC @interface
&& !isInObjCSelector // not objC @selector
&& !isDigit(peekNextChar()) // not a bit field
&& !isInEnum // not an enum with a base type
&& !isInAsm // not in extended assembler
&& !isInAsmOneLine // not in extended assembler
&& !isInAsmBlock) // not in extended assembler
{
passedColon = true;
}
if (isCStyle()
&& shouldPadMethodColon
&& (squareBracketCount > 0 || isInObjCMethodDefinition || isInObjCSelector)
&& previousChar != ':' // not part of '::'
&& peekNextChar() != ':' // not part of '::'
&& !foundQuestionMark) // not in a ?: sequence
padObjCMethodColon();
if (isInObjCInterface)
{
appendSpacePad();
if ((int) currentLine.length() > charNum + 1 && !isWhiteSpace(currentLine[charNum + 1]))
currentLine.insert(charNum + 1, " ");
}
}
if (currentChar == '?')
foundQuestionMark = true;
if (isPotentialHeader && !isInTemplate)
{
if (findKeyword(currentLine, charNum, AS_NEW))
isInPotentialCalculation = false;
if (findKeyword(currentLine, charNum, AS_RETURN))
{
isInPotentialCalculation = true; // return is the same as an = sign
isImmediatelyPostReturn = true;
}
if (findKeyword(currentLine, charNum, AS_OPERATOR))
isImmediatelyPostOperator = true;
if (isCStyle()
&& findKeyword(currentLine, charNum, AS_THROW)
&& previousCommandChar != ')'
&& !foundPreCommandHeader) // 'const' throw()
isImmediatelyPostThrow = true;
if (isCStyle() && findKeyword(currentLine, charNum, AS_ENUM))
isInEnum = true;
if (isCStyle() && findKeyword(currentLine, charNum, AS_EXTERN) && isExternC())
isInExternC = true;
// Objective-C NSException macros are preCommandHeaders
if (isCStyle() && findKeyword(currentLine, charNum, AS_NS_DURING))
foundPreCommandMacro = true;
if (isCStyle() && findKeyword(currentLine, charNum, AS_NS_HANDLER))
foundPreCommandMacro = true;
if (isCStyle() && isExecSQL(currentLine, charNum))
isInExecSQL = true;
if (isCStyle())
{
if (findKeyword(currentLine, charNum, AS_ASM)
|| findKeyword(currentLine, charNum, AS__ASM__))
{
isInAsm = true;
}
else if (findKeyword(currentLine, charNum, AS_MS_ASM) // microsoft specific
|| findKeyword(currentLine, charNum, AS_MS__ASM))
{
int index = 4;
if (peekNextChar() == '_') // check for __asm
index = 5;
char peekedChar = ASBase::peekNextChar(currentLine, charNum + index);
if (peekedChar == '{' || peekedChar == ' ')
isInAsmBlock = true;
else
isInAsmOneLine = true;
}
}
if (isJavaStyle()
&& (findKeyword(currentLine, charNum, AS_STATIC)
&& isNextCharOpeningBracket(charNum + 6)))
isJavaStaticConstructor = true;
if (isSharpStyle()
&& (findKeyword(currentLine, charNum, AS_DELEGATE)
|| findKeyword(currentLine, charNum, AS_UNCHECKED)))
isSharpDelegate = true;
// append the entire name
string name = getCurrentWord(currentLine, charNum);
// must pad the 'and' and 'or' operators if required
if (name == "and" || name == "or")
{
if (shouldPadOperators && previousNonWSChar != ':')
{
appendSpacePad();
appendOperator(name);
goForward(name.length() - 1);
if (!isBeforeAnyComment()
&& !(currentLine.compare(charNum + 1, 1, AS_SEMICOLON) == 0)
&& !(currentLine.compare(charNum + 1, 2, AS_SCOPE_RESOLUTION) == 0))
appendSpaceAfter();
}
else
{
appendOperator(name);
goForward(name.length() - 1);
}
}
else
{
appendSequence(name);
goForward(name.length() - 1);
}
continue;
} // (isPotentialHeader && !isInTemplate)
// determine if this is an Objective-C statement
if (currentChar == '@'
&& isCharPotentialHeader(currentLine, charNum + 1)
&& findKeyword(currentLine, charNum + 1, AS_INTERFACE)
&& bracketTypeStack->back() == NULL_TYPE)
{
isInObjCInterface = true;
string name = '@' + AS_INTERFACE;
appendSequence(name);
goForward(name.length() - 1);
continue;
}
else if (currentChar == '@'
&& isCharPotentialHeader(currentLine, charNum + 1)
&& findKeyword(currentLine, charNum + 1, AS_SELECTOR))
{
isInObjCSelector = true;
string name = '@' + AS_SELECTOR;
appendSequence(name);
goForward(name.length() - 1);
continue;
}
else if ((currentChar == '-' || currentChar == '+')
&& peekNextChar() == '('
&& bracketTypeStack->back() == NULL_TYPE
&& !isInPotentialCalculation)
{
isInObjCMethodDefinition = true;
isInObjCInterface = false;
appendCurrentChar();
if (shouldPadMethodPrefix || shouldUnPadMethodPrefix)
{
size_t i = currentLine.find_first_not_of(" \t", charNum + 1);
if (i != string::npos)
goForward(i - charNum - 1);
if (shouldPadMethodPrefix)
appendSpaceAfter();
}
continue;
}
// determine if this is a potential calculation
bool isPotentialOperator = isCharPotentialOperator(currentChar);
newHeader = NULL;
if (isPotentialOperator)
{
newHeader = findOperator(operators);
// check for Java ? wildcard
if (newHeader == &AS_GCC_MIN_ASSIGN && isJavaStyle() && isInTemplate)
newHeader = NULL;
if (newHeader != NULL)
{
if (newHeader == &AS_LAMBDA)
foundPreCommandHeader = true;
// correct mistake of two >> closing a template
if (isInTemplate && (newHeader == &AS_GR_GR || newHeader == &AS_GR_GR_GR))
newHeader = &AS_GR;
if (!isInPotentialCalculation)
{
// must determine if newHeader is an assignment operator
// do NOT use findOperator!!!
if (find(assignmentOperators->begin(), assignmentOperators->end(), newHeader)
!= assignmentOperators->end())
{
foundPreCommandHeader = false;
char peekedChar = peekNextChar();
isInPotentialCalculation = (!(newHeader == &AS_EQUAL && peekedChar == '*')
&& !(newHeader == &AS_EQUAL && peekedChar == '&'));
}
}
}
}
// process pointers and references
// check newHeader to eliminate things like '&&' sequence
if (!isJavaStyle()
&& (newHeader == &AS_MULT
|| newHeader == &AS_BIT_AND
|| newHeader == &AS_BIT_XOR
|| newHeader == &AS_AND)
&& isPointerOrReference())
{
if (!isDereferenceOrAddressOf())
formatPointerOrReference();
else
{
appendOperator(*newHeader);
goForward(newHeader->length() - 1);
}
isImmediatelyPostPointerOrReference = true;
continue;
}
if (shouldPadOperators && newHeader != NULL)
{
padOperators(newHeader);
continue;
}
// pad commas and semi-colons
if (currentChar == ';'
|| (currentChar == ',' && shouldPadOperators))
{
char nextChar = ' ';
if (charNum + 1 < (int) currentLine.length())
nextChar = currentLine[charNum + 1];
if (!isWhiteSpace(nextChar)
&& nextChar != '}'
&& nextChar != ')'
&& nextChar != ']'
&& nextChar != '>'
&& nextChar != ';'
&& !isBeforeAnyComment()
/* && !(isBracketType(bracketTypeStack->back(), ARRAY_TYPE)) */
)
{
appendCurrentChar();
appendSpaceAfter();
continue;
}
}
// do NOT use 'continue' after this, it must do padParens if necessary
if (currentChar == '('
&& shouldPadHeader
&& (isCharImmediatelyPostReturn || isCharImmediatelyPostThrow))
appendSpacePad();
if ((currentChar == '(' || currentChar == ')')
&& (shouldPadParensOutside || shouldPadParensInside || shouldUnPadParens || shouldPadFirstParen))
{
padParens();
continue;
}
// bypass the entire operator
if (newHeader != NULL)
{
appendOperator(*newHeader);
goForward(newHeader->length() - 1);
continue;
}
appendCurrentChar();
} // end of while loop * end of while loop * end of while loop * end of while loop
// return a beautified (i.e. correctly indented) line.
string beautifiedLine;
size_t readyFormattedLineLength = trim(readyFormattedLine).length();
if (prependEmptyLine // prepend a blank line before this formatted line
&& readyFormattedLineLength > 0
&& previousReadyFormattedLineLength > 0)
{
isLineReady = true; // signal a waiting readyFormattedLine
beautifiedLine = beautify("");
previousReadyFormattedLineLength = 0;
// call the enhancer for new empty lines
enhancer->enhance(beautifiedLine, isInPreprocessorBeautify, isInBeautifySQL);
}
else // format the current formatted line
{
isLineReady = false;
horstmannIndentInStatement = horstmannIndentChars;
beautifiedLine = beautify(readyFormattedLine);
previousReadyFormattedLineLength = readyFormattedLineLength;
// the enhancer is not called for no-indent line comments
if (!lineCommentNoBeautify)
enhancer->enhance(beautifiedLine, isInPreprocessorBeautify, isInBeautifySQL);
horstmannIndentChars = 0;
lineCommentNoBeautify = lineCommentNoIndent;
lineCommentNoIndent = false;
isElseHeaderIndent = elseHeaderFollowsComments;
isCaseHeaderCommentIndent = caseHeaderFollowsComments;
if (isCharImmediatelyPostNonInStmt)
{
isNonInStatementArray = false;
isCharImmediatelyPostNonInStmt = false;
}
isInPreprocessorBeautify = isInPreprocessor; // used by ASEnhancer
isInBeautifySQL = isInExecSQL; // used by ASEnhancer
}
prependEmptyLine = false;
assert(computeChecksumOut(beautifiedLine));
return beautifiedLine;
}
/**
* check if there are any indented lines ready to be read by nextLine()
*
* @return are there any indented lines ready?
*/
bool ASFormatter::hasMoreLines() const
{
return !endOfCodeReached;
}
/**
* comparison function for BracketType enum
*/
bool ASFormatter::isBracketType(BracketType a, BracketType b) const
{
return ((a & b) == b);
}
/**
* set the formatting style.
*
* @param mode the formatting style.
*/
void ASFormatter::setFormattingStyle(FormatStyle style)
{
formattingStyle = style;
}
/**
* set the add brackets mode.
* options:
* true brackets added to headers for single line statements.
* false brackets NOT added to headers for single line statements.
*
* @param mode the add brackets mode.
*/
void ASFormatter::setAddBracketsMode(bool state)
{
shouldAddBrackets = state;
}
/**
* set the add one line brackets mode.
* options:
* true one line brackets added to headers for single line statements.
* false one line brackets NOT added to headers for single line statements.
*
* @param mode the add one line brackets mode.
*/
void ASFormatter::setAddOneLineBracketsMode(bool state)
{
shouldAddBrackets = state;
shouldAddOneLineBrackets = state;
}
/**
* set the remove brackets mode.
* options:
* true brackets removed from headers for single line statements.
* false brackets NOT removed from headers for single line statements.
*
* @param mode the remove brackets mode.
*/
void ASFormatter::setRemoveBracketsMode(bool state)
{
shouldRemoveBrackets = state;
}
/**
* set the bracket formatting mode.
* options:
*
* @param mode the bracket formatting mode.
*/
void ASFormatter::setBracketFormatMode(BracketMode mode)
{
bracketFormatMode = mode;
}
/**
* set 'break after' mode for maximum code length
*
* @param state the 'break after' mode.
*/
void ASFormatter::setBreakAfterMode(bool state)
{
shouldBreakLineAfterLogical = state;
}
/**
* set closing header bracket breaking mode
* options:
* true brackets just before closing headers (e.g. 'else', 'catch')
* will be broken, even if standard brackets are attached.
* false closing header brackets will be treated as standard brackets.
*
* @param state the closing header bracket breaking mode.
*/
void ASFormatter::setBreakClosingHeaderBracketsMode(bool state)
{
shouldBreakClosingHeaderBrackets = state;
}
/**
* set 'else if()' breaking mode
* options:
* true 'else' headers will be broken from their succeeding 'if' headers.
* false 'else' headers will be attached to their succeeding 'if' headers.
*
* @param state the 'else if()' breaking mode.
*/
void ASFormatter::setBreakElseIfsMode(bool state)
{
shouldBreakElseIfs = state;
}
/**
* set maximum code length
*
* @param max the maximum code length.
*/
void ASFormatter::setMaxCodeLength(int max)
{
maxCodeLength = max;
}
/**
* set operator padding mode.
* options:
* true statement operators will be padded with spaces around them.
* false statement operators will not be padded.
*
* @param state the padding mode.
*/
void ASFormatter::setOperatorPaddingMode(bool state)
{
shouldPadOperators = state;
}
/**
* set parenthesis outside padding mode.
* options:
* true statement parentheses will be padded with spaces around them.
* false statement parentheses will not be padded.
*
* @param state the padding mode.
*/
void ASFormatter::setParensOutsidePaddingMode(bool state)
{
shouldPadParensOutside = state;
}
/**
* set parenthesis inside padding mode.
* options:
* true statement parenthesis will be padded with spaces around them.
* false statement parenthesis will not be padded.
*
* @param state the padding mode.
*/
void ASFormatter::setParensInsidePaddingMode(bool state)
{
shouldPadParensInside = state;
}
/**
* set padding mode before one or more open parentheses.
* options:
* true first open parenthesis will be padded with a space before.
* false first open parenthesis will not be padded.
*
* @param state the padding mode.
*/
void ASFormatter::setParensFirstPaddingMode(bool state)
{
shouldPadFirstParen = state;
}
/**
* set header padding mode.
* options:
* true headers will be padded with spaces around them.
* false headers will not be padded.
*
* @param state the padding mode.
*/
void ASFormatter::setParensHeaderPaddingMode(bool state)
{
shouldPadHeader = state;
}
/**
* set parenthesis unpadding mode.
* options:
* true statement parenthesis will be unpadded with spaces removed around them.
* false statement parenthesis will not be unpadded.
*
* @param state the padding mode.
*/
void ASFormatter::setParensUnPaddingMode(bool state)
{
shouldUnPadParens = state;
}
/**
* Set strip comment prefix mode.
* options:
* true strip leading '*' in a comment.
* false leading '*' in a comment will be left unchanged.
*
* @param state the strip comment prefix mode.
*/
void ASFormatter::setStripCommentPrefix(bool state)
{
shouldStripCommentPrefix = state;
}
/**
* set objective-c '-' or '+' class prefix padding mode.
* options:
* true class prefix will be padded a spaces after them.
* false class prefix will be left unchanged.
*
* @param state the padding mode.
*/
void ASFormatter::setMethodPrefixPaddingMode(bool state)
{
shouldPadMethodPrefix = state;
}
/**
* set objective-c '-' or '+' class prefix unpadding mode.
* options:
* true class prefix will be unpadded with spaces after them removed.
* false class prefix will left unchanged.
*
* @param state the unpadding mode.
*/
void ASFormatter::setMethodPrefixUnPaddingMode(bool state)
{
shouldUnPadMethodPrefix = state;
}
/**
* set objective-c method colon padding mode.
*
* @param mode objective-c colon padding mode.
*/
void ASFormatter::setObjCColonPaddingMode(ObjCColonPad mode)
{
shouldPadMethodColon = true;
objCColonPadMode = mode;
}
/**
* set option to attach closing brackets
*
* @param state true = attach, false = don't attach.
*/
void ASFormatter::setAttachClosingBracket(bool state)
{
shouldAttachClosingBracket = state;
}
/**
* set option to attach class brackets
*
* @param state true = attach, false = use style default.
*/
void ASFormatter::setAttachClass(bool state)
{
shouldAttachClass = state;
}
/**
* set option to attach extern "C" brackets
*
* @param state true = attach, false = use style default.
*/
void ASFormatter::setAttachExternC(bool state)
{
shouldAttachExternC = state;
}
/**
* set option to attach namespace brackets
*
* @param state true = attach, false = use style default.
*/
void ASFormatter::setAttachNamespace(bool state)
{
shouldAttachNamespace = state;
}
/**
* set option to attach inline brackets
*
* @param state true = attach, false = use style default.
*/
void ASFormatter::setAttachInline(bool state)
{
shouldAttachInline = state;
}
/**
* set option to break/not break one-line blocks
*
* @param state true = break, false = don't break.
*/
void ASFormatter::setBreakOneLineBlocksMode(bool state)
{
shouldBreakOneLineBlocks = state;
}
void ASFormatter::setCloseTemplatesMode(bool state)
{
shouldCloseTemplates = state;
}
/**
* set option to break/not break lines consisting of multiple statements.
*
* @param state true = break, false = don't break.
*/
void ASFormatter::setSingleStatementsMode(bool state)
{
shouldBreakOneLineStatements = state;
}
/**
* set option to convert tabs to spaces.
*
* @param state true = convert, false = don't convert.
*/
void ASFormatter::setTabSpaceConversionMode(bool state)
{
shouldConvertTabs = state;
}
/**
* set option to indent comments in column 1.
*
* @param state true = indent, false = don't indent.
*/
void ASFormatter::setIndentCol1CommentsMode(bool state)
{
shouldIndentCol1Comments = state;
}
/**
* set option to force all line ends to a particular style.
*
* @param fmt format enum value
*/
void ASFormatter::setLineEndFormat(LineEndFormat fmt)
{
lineEnd = fmt;
}
/**
* set option to break unrelated blocks of code with empty lines.
*
* @param state true = convert, false = don't convert.
*/
void ASFormatter::setBreakBlocksMode(bool state)
{
shouldBreakBlocks = state;
}
/**
* set option to break closing header blocks of code (such as 'else', 'catch', ...) with empty lines.
*
* @param state true = convert, false = don't convert.
*/
void ASFormatter::setBreakClosingHeaderBlocksMode(bool state)
{
shouldBreakClosingHeaderBlocks = state;
}
/**
* set option to delete empty lines.
*
* @param state true = delete, false = don't delete.
*/
void ASFormatter::setDeleteEmptyLinesMode(bool state)
{
shouldDeleteEmptyLines = state;
}
/**
* set the pointer alignment.
*
* @param alignment the pointer alignment.
*/
void ASFormatter::setPointerAlignment(PointerAlign alignment)
{
pointerAlignment = alignment;
}
void ASFormatter::setReferenceAlignment(ReferenceAlign alignment)
{
referenceAlignment = alignment;
}
/**
* jump over several characters.
*
* @param i the number of characters to jump over.
*/
void ASFormatter::goForward(int i)
{
while (--i >= 0)
getNextChar();
}
/**
* peek at the next unread character.
*
* @return the next unread character.
*/
char ASFormatter::peekNextChar() const
{
char ch = ' ';
size_t peekNum = currentLine.find_first_not_of(" \t", charNum + 1);
if (peekNum == string::npos)
return ch;
ch = currentLine[peekNum];
return ch;
}
/**
* check if current placement is before a comment
*
* @return is before a comment.
*/
bool ASFormatter::isBeforeComment() const
{
bool foundComment = false;
size_t peekNum = currentLine.find_first_not_of(" \t", charNum + 1);
if (peekNum == string::npos)
return foundComment;
foundComment = (currentLine.compare(peekNum, 2, "/*") == 0);
return foundComment;
}
/**
* check if current placement is before a comment or line-comment
*
* @return is before a comment or line-comment.
*/
bool ASFormatter::isBeforeAnyComment() const
{
bool foundComment = false;
size_t peekNum = currentLine.find_first_not_of(" \t", charNum + 1);
if (peekNum == string::npos)
return foundComment;
foundComment = (currentLine.compare(peekNum, 2, "/*") == 0
|| currentLine.compare(peekNum, 2, "//") == 0);
return foundComment;
}
/**
* check if current placement is before a comment or line-comment
* if a block comment it must be at the end of the line
*
* @return is before a comment or line-comment.
*/
bool ASFormatter::isBeforeAnyLineEndComment(int startPos) const
{
bool foundLineEndComment = false;
size_t peekNum = currentLine.find_first_not_of(" \t", startPos + 1);
if (peekNum != string::npos)
{
if (currentLine.compare(peekNum, 2, "//") == 0)
foundLineEndComment = true;
else if (currentLine.compare(peekNum, 2, "/*") == 0)
{
// comment must be closed on this line with nothing after it
size_t endNum = currentLine.find("*/", peekNum + 2);
if (endNum != string::npos)
{
size_t nextChar = currentLine.find_first_not_of(" \t", endNum + 2);
if (nextChar == string::npos)
foundLineEndComment = true;
}
}
}
return foundLineEndComment;
}
/**
* check if current placement is before a comment followed by a line-comment
*
* @return is before a multiple line-end comment.
*/
bool ASFormatter::isBeforeMultipleLineEndComments(int startPos) const
{
bool foundMultipleLineEndComment = false;
size_t peekNum = currentLine.find_first_not_of(" \t", startPos + 1);
if (peekNum != string::npos)
{
if (currentLine.compare(peekNum, 2, "/*") == 0)
{
// comment must be closed on this line with nothing after it
size_t endNum = currentLine.find("*/", peekNum + 2);
if (endNum != string::npos)
{
size_t nextChar = currentLine.find_first_not_of(" \t", endNum + 2);
if (nextChar != string::npos
&& currentLine.compare(nextChar, 2, "//") == 0)
foundMultipleLineEndComment = true;
}
}
}
return foundMultipleLineEndComment;
}
/**
* get the next character, increasing the current placement in the process.
* the new character is inserted into the variable currentChar.
*
* @return whether succeeded to receive the new character.
*/
bool ASFormatter::getNextChar()
{
isInLineBreak = false;
previousChar = currentChar;
if (!isWhiteSpace(currentChar))
{
previousNonWSChar = currentChar;
if (!isInComment && !isInLineComment && !isInQuote
&& !isImmediatelyPostComment
&& !isImmediatelyPostLineComment
&& !isInPreprocessor
&& !isSequenceReached("/*")
&& !isSequenceReached("//"))
previousCommandChar = currentChar;
}
if (charNum + 1 < (int) currentLine.length()
&& (!isWhiteSpace(peekNextChar()) || isInComment || isInLineComment))
{
currentChar = currentLine[++charNum];
if (currentChar == '\t' && shouldConvertTabs)
convertTabToSpaces();
return true;
}
// end of line has been reached
return getNextLine();
}
/**
* get the next line of input, increasing the current placement in the process.
*
* @param sequence the sequence to append.
* @return whether succeeded in reading the next line.
*/
bool ASFormatter::getNextLine(bool emptyLineWasDeleted /*false*/)
{
if (sourceIterator->hasMoreLines())
{
if (appendOpeningBracket)
currentLine = "{"; // append bracket that was removed from the previous line
else
{
currentLine = sourceIterator->nextLine(emptyLineWasDeleted);
assert(computeChecksumIn(currentLine));
}
// reset variables for new line
inLineNumber++;
if (endOfAsmReached)
endOfAsmReached = isInAsmBlock = isInAsm = false;
shouldKeepLineUnbroken = false;
isInCommentStartLine = false;
isInCase = false;
isInAsmOneLine = false;
isHeaderInMultiStatementLine = false;
isInQuoteContinuation = isInVerbatimQuote | haveLineContinuationChar;
haveLineContinuationChar = false;
isImmediatelyPostEmptyLine = lineIsEmpty;
previousChar = ' ';
if (currentLine.length() == 0)
currentLine = string(" "); // a null is inserted if this is not done
// unless reading in the first line of the file, break a new line.
if (!isVirgin)
isInLineBreak = true;
else
isVirgin = false;
// TODO: FIX FOR BROKEN CASE STATEMANTS - RELEASE 2.02.1
// REMOVE AT AN APPROPRIATE TIME
if ((currentHeader == &AS_CASE || currentHeader == &AS_DEFAULT)
&& isInLineBreak
&& !isImmediatelyPostLineComment)
{
// check for split line
if ((formattedLine.length() >= 4
&& formattedLine.substr(formattedLine.length() - 4, 4) == "case")
|| (formattedLine.length() >= 7
&& formattedLine.substr(formattedLine.length() - 7, 7) == "default")
|| (formattedLine[formattedLine.length() - 1] == '\''
&& findNextChar(currentLine, ':') != string::npos)
)
{
isInLineBreak = false;
isInCase = true;
if (formattedLine.substr(formattedLine.length() - 4, 4) == "case")
appendSpacePad();
}
}
// END OF FIX
if (isImmediatelyPostNonInStmt)
{
isCharImmediatelyPostNonInStmt = true;
isImmediatelyPostNonInStmt = false;
}
// check if is in preprocessor before line trimming
// a blank line after a \ will remove the flag
isImmediatelyPostPreprocessor = isInPreprocessor;
if (!isInComment
&& (previousNonWSChar != '\\'
|| isEmptyLine(currentLine)))
isInPreprocessor = false;
if (passedSemicolon)
isInExecSQL = false;
initNewLine();
currentChar = currentLine[charNum];
if (isInHorstmannRunIn && previousNonWSChar == '{' && !isInComment)
isInLineBreak = false;
isInHorstmannRunIn = false;
if (currentChar == '\t' && shouldConvertTabs)
convertTabToSpaces();
// check for an empty line inside a command bracket.
// if yes then read the next line (calls getNextLine recursively).
// must be after initNewLine.
if (shouldDeleteEmptyLines
&& lineIsEmpty
&& isBracketType((*bracketTypeStack)[bracketTypeStack->size() - 1], COMMAND_TYPE))
{
if (!shouldBreakBlocks || previousNonWSChar == '{' || !commentAndHeaderFollows())
{
isInPreprocessor = isImmediatelyPostPreprocessor; // restore
lineIsEmpty = false;
return getNextLine(true);
}
}
return true;
}
else
{
endOfCodeReached = true;
return false;
}
}
/**
* jump over the leading white space in the current line,
* IF the line does not begin a comment or is in a preprocessor definition.
*/
void ASFormatter::initNewLine()
{
size_t len = currentLine.length();
size_t tabSize = getTabLength();
charNum = 0;
// don't trim these
if (isInQuoteContinuation
|| (isInPreprocessor && !getPreprocDefineIndent()))
return;
// SQL continuation lines must be adjusted so the leading spaces
// is equivalent to the opening EXEC SQL
if (isInExecSQL)
{
// replace leading tabs with spaces
// so that continuation indent will be spaces
size_t tabCount_ = 0;
size_t i;
for (i = 0; i < currentLine.length(); i++)
{
if (!isWhiteSpace(currentLine[i])) // stop at first text
break;
if (currentLine[i] == '\t')
{
size_t numSpaces = tabSize - ((tabCount_ + i) % tabSize);
currentLine.replace(i, 1, numSpaces, ' ');
tabCount_++;
i += tabSize - 1;
}
}
// this will correct the format if EXEC SQL is not a hanging indent
trimContinuationLine();
return;
}
// comment continuation lines must be adjusted so the leading spaces
// is equivalent to the opening comment
if (isInComment)
{
if (noTrimCommentContinuation)
leadingSpaces = tabIncrementIn = 0;
trimContinuationLine();
return;
}
// compute leading spaces
isImmediatelyPostCommentOnly = lineIsLineCommentOnly || lineEndsInCommentOnly;
lineIsLineCommentOnly = false;
lineEndsInCommentOnly = false;
doesLineStartComment = false;
currentLineBeginsWithBracket = false;
lineIsEmpty = false;
currentLineFirstBracketNum = string::npos;
tabIncrementIn = 0;
// bypass whitespace at the start of a line
// preprocessor tabs are replaced later in the program
for (charNum = 0; isWhiteSpace(currentLine[charNum]) && charNum + 1 < (int) len; charNum++)
{
if (currentLine[charNum] == '\t' && !isInPreprocessor)
tabIncrementIn += tabSize - 1 - ((tabIncrementIn + charNum) % tabSize);
}
leadingSpaces = charNum + tabIncrementIn;
if (isSequenceReached("/*"))
{
doesLineStartComment = true;
}
else if (isSequenceReached("//"))
{
lineIsLineCommentOnly = true;
}
else if (isSequenceReached("{"))
{
currentLineBeginsWithBracket = true;
currentLineFirstBracketNum = charNum;
size_t firstText = currentLine.find_first_not_of(" \t", charNum + 1);
if (firstText != string::npos)
{
if (currentLine.compare(firstText, 2, "//") == 0)
lineIsLineCommentOnly = true;
else if (currentLine.compare(firstText, 2, "/*") == 0
|| isExecSQL(currentLine, firstText))
{
// get the extra adjustment
size_t j;
for (j = charNum + 1; j < firstText && isWhiteSpace(currentLine[j]); j++)
{
if (currentLine[j] == '\t')
tabIncrementIn += tabSize - 1 - ((tabIncrementIn + j) % tabSize);
}
leadingSpaces = j + tabIncrementIn;
if (currentLine.compare(firstText, 2, "/*") == 0)
doesLineStartComment = true;
}
}
}
else if (isWhiteSpace(currentLine[charNum]) && !(charNum + 1 < (int) currentLine.length()))
{
lineIsEmpty = true;
}
// do not trim indented preprocessor define (except for comment continuation lines)
if (isInPreprocessor)
{
if (!doesLineStartComment)
leadingSpaces = 0;
charNum = 0;
}
}
/**
* Append a character to the current formatted line.
* The formattedLine split points are updated.
*
* @param char the character to append.
* @param canBreakLine if true, a registered line-break
*/
void ASFormatter::appendChar(char ch, bool canBreakLine)
{
if (canBreakLine && isInLineBreak)
breakLine();
formattedLine.append(1, ch);
isImmediatelyPostCommentOnly = false;
if (maxCodeLength != string::npos)
{
// These compares reduce the frequency of function calls.
if (isOkToSplitFormattedLine())
updateFormattedLineSplitPoints(ch);
if (formattedLine.length() > maxCodeLength)
testForTimeToSplitFormattedLine();
}
}
/**
* Append a string sequence to the current formatted line.
* The formattedLine split points are NOT updated.
* But the formattedLine is checked for time to split.
*
* @param sequence the sequence to append.
* @param canBreakLine if true, a registered line-break
*/
void ASFormatter::appendSequence(const string &sequence, bool canBreakLine)
{
if (canBreakLine && isInLineBreak)
breakLine();
formattedLine.append(sequence);
if (formattedLine.length() > maxCodeLength)
testForTimeToSplitFormattedLine();
}
/**
* Append an operator sequence to the current formatted line.
* The formattedLine split points are updated.
*
* @param sequence the sequence to append.
* @param canBreakLine if true, a registered line-break
*/
void ASFormatter::appendOperator(const string &sequence, bool canBreakLine)
{
if (canBreakLine && isInLineBreak)
breakLine();
formattedLine.append(sequence);
if (maxCodeLength != string::npos)
{
// These compares reduce the frequency of function calls.
if (isOkToSplitFormattedLine())
updateFormattedLineSplitPointsOperator(sequence);
if (formattedLine.length() > maxCodeLength)
testForTimeToSplitFormattedLine();
}
}
/**
* append a space to the current formattedline, UNLESS the
* last character is already a white-space character.
*/
void ASFormatter::appendSpacePad()
{
int len = formattedLine.length();
if (len > 0 && !isWhiteSpace(formattedLine[len - 1]))
{
formattedLine.append(1, ' ');
spacePadNum++;
if (maxCodeLength != string::npos)
{
// These compares reduce the frequency of function calls.
if (isOkToSplitFormattedLine())
updateFormattedLineSplitPoints(' ');
if (formattedLine.length() > maxCodeLength)
testForTimeToSplitFormattedLine();
}
}
}
/**
* append a space to the current formattedline, UNLESS the
* next character is already a white-space character.
*/
void ASFormatter::appendSpaceAfter()
{
int len = currentLine.length();
if (charNum + 1 < len && !isWhiteSpace(currentLine[charNum + 1]))
{
formattedLine.append(1, ' ');
spacePadNum++;
if (maxCodeLength != string::npos)
{
// These compares reduce the frequency of function calls.
if (isOkToSplitFormattedLine())
updateFormattedLineSplitPoints(' ');
if (formattedLine.length() > maxCodeLength)
testForTimeToSplitFormattedLine();
}
}
}
/**
* register a line break for the formatted line.
*/
void ASFormatter::breakLine(bool isSplitLine /*false*/)
{
isLineReady = true;
isInLineBreak = false;
spacePadNum = nextLineSpacePadNum;
nextLineSpacePadNum = 0;
readyFormattedLine = formattedLine;
formattedLine = "";
// queue an empty line prepend request if one exists
prependEmptyLine = isPrependPostBlockEmptyLineRequested;
if (!isSplitLine)
{
formattedLineCommentNum = string::npos;
clearFormattedLineSplitPoints();
if (isAppendPostBlockEmptyLineRequested)
{
isAppendPostBlockEmptyLineRequested = false;
isPrependPostBlockEmptyLineRequested = true;
}
else
isPrependPostBlockEmptyLineRequested = false;
}
}
/**
* check if the currently reached open-bracket (i.e. '{')
* opens a:
* - a definition type block (such as a class or namespace),
* - a command block (such as a method block)
* - a static array
* this method takes for granted that the current character
* is an opening bracket.
*
* @return the type of the opened block.
*/
BracketType ASFormatter::getBracketType()
{
assert(currentChar == '{');
BracketType returnVal;
if ((previousNonWSChar == '='
|| isBracketType(bracketTypeStack->back(), ARRAY_TYPE))
&& previousCommandChar != ')')
returnVal = ARRAY_TYPE;
else if (foundPreDefinitionHeader && previousCommandChar != ')')
{
returnVal = DEFINITION_TYPE;
if (foundNamespaceHeader)
returnVal = (BracketType)(returnVal | NAMESPACE_TYPE);
else if (foundClassHeader)
returnVal = (BracketType)(returnVal | CLASS_TYPE);
else if (foundStructHeader)
returnVal = (BracketType)(returnVal | STRUCT_TYPE);
else if (foundInterfaceHeader)
returnVal = (BracketType)(returnVal | INTERFACE_TYPE);
}
else
{
bool isCommandType = (foundPreCommandHeader
|| foundPreCommandMacro
|| (currentHeader != NULL && isNonParenHeader)
|| (previousCommandChar == ')')
|| (previousCommandChar == ':' && !foundQuestionMark)
|| (previousCommandChar == ';')
|| ((previousCommandChar == '{' || previousCommandChar == '}')
&& isPreviousBracketBlockRelated)
|| isInObjCMethodDefinition
|| isInObjCInterface
|| isJavaStaticConstructor
|| isSharpDelegate);
// C# methods containing 'get', 'set', 'add', and 'remove' do NOT end with parens
if (!isCommandType && isSharpStyle() && isNextWordSharpNonParenHeader(charNum + 1))
{
isCommandType = true;
isSharpAccessor = true;
}
if (isInExternC)
returnVal = (isCommandType ? COMMAND_TYPE : EXTERN_TYPE);
else
returnVal = (isCommandType ? COMMAND_TYPE : ARRAY_TYPE);
}
int foundOneLineBlock = isOneLineBlockReached(currentLine, charNum);
// this assumes each array definition is on a single line
// (foundOneLineBlock == 2) is a one line block followed by a comma
if (foundOneLineBlock == 2 && returnVal == COMMAND_TYPE)
returnVal = ARRAY_TYPE;
if (foundOneLineBlock > 0) // found one line block
returnVal = (BracketType)(returnVal | SINGLE_LINE_TYPE);
if (isBracketType(returnVal, ARRAY_TYPE) && isNonInStatementArrayBracket())
{
returnVal = (BracketType)(returnVal | ARRAY_NIS_TYPE);
isNonInStatementArray = true;
isImmediatelyPostNonInStmt = false; // in case of "},{"
nonInStatementBracket = formattedLine.length() - 1;
}
return returnVal;
}
/**
* check if a line is empty
*
* @return whether line is empty
*/
bool ASFormatter::isEmptyLine(const string &line) const
{
return line.find_first_not_of(" \t") == string::npos;
}
/**
* Check if the following text is "C" as in extern "C".
*
* @return whether the statement is extern "C"
*/
bool ASFormatter::isExternC() const
{
// charNum should be at 'extern'
assert(!isWhiteSpace(currentLine[charNum]));
size_t startQuote = currentLine.find_first_of(" \t\"", charNum);
if (startQuote == string::npos)
return false;
startQuote = currentLine.find_first_not_of(" \t", startQuote);
if (startQuote == string::npos)
return false;
if (currentLine.compare(startQuote, 3, "\"C\"") != 0)
return false;
return true;
}
/**
* Check if the currently reached '*', '&' or '^' character is
* a pointer-or-reference symbol, or another operator.
* A pointer dereference (*) or an "address of" character (&)
* counts as a pointer or reference because it is not an
* arithmetic operator.
*
* @return whether current character is a reference-or-pointer
*/
bool ASFormatter::isPointerOrReference() const
{
assert(currentChar == '*' || currentChar == '&' || currentChar == '^');
if (isJavaStyle())
return false;
if (isCharImmediatelyPostOperator)
return false;
// get the last legal word (may be a number)
string lastWord = getPreviousWord(currentLine, charNum);
if (lastWord.empty())
lastWord = " ";
// check for preceding or following numeric values
string nextText = peekNextText(currentLine.substr(charNum + 1));
if (nextText.length() == 0)
nextText = " ";
char nextChar = nextText[0];
if (isDigit(lastWord[0])
|| isDigit(nextChar)
|| nextChar == '!'
|| nextChar == '~')
return false;
if (isPointerOrReferenceVariable(lastWord))
return true;
//check for rvalue reference
if (currentChar == '&' && nextChar == '&')
{
if (currentHeader != NULL || isInPotentialCalculation)
return false;
if (parenStack->back() > 0 && isBracketType(bracketTypeStack->back(), COMMAND_TYPE))
return false;
return true;
}
if (nextChar == '*'
|| previousNonWSChar == '='
|| previousNonWSChar == '('
|| previousNonWSChar == '['
|| isCharImmediatelyPostReturn
|| isInTemplate
|| isCharImmediatelyPostTemplate
|| currentHeader == &AS_CATCH)
return true;
if (isBracketType(bracketTypeStack->back(), ARRAY_TYPE)
&& isLegalNameChar(lastWord[0])
&& isLegalNameChar(nextChar)
&& previousNonWSChar != ')')
{
if (isArrayOperator())
return false;
}
// checks on operators in parens
if (parenStack->back() > 0
&& isLegalNameChar(lastWord[0])
&& isLegalNameChar(nextChar))
{
// if followed by an assignment it is a pointer or reference
// if followed by semicolon it is a pointer or reference in range-based for
const string* followingOperator = getFollowingOperator();
if (followingOperator
&& followingOperator != &AS_MULT
&& followingOperator != &AS_BIT_AND)
{
if (followingOperator == &AS_ASSIGN || followingOperator == &AS_COLON)
return true;
else
return false;
}
if (!isBracketType(bracketTypeStack->back(), COMMAND_TYPE))
return true;
else
return false;
}
// checks on operators in parens with following '('
if (parenStack->back() > 0
&& nextChar == '('
&& previousNonWSChar != ','
&& previousNonWSChar != '('
&& previousNonWSChar != '!'
&& previousNonWSChar != '&'
&& previousNonWSChar != '*'
&& previousNonWSChar != '|')
return false;
if (nextChar == '-'
|| nextChar == '+')
{
size_t nextNum = currentLine.find_first_not_of(" \t", charNum + 1);
if (nextNum != string::npos)
{
if (currentLine.compare(nextNum, 2, "++") != 0
&& currentLine.compare(nextNum, 2, "--") != 0)
return false;
}
}
bool isPR = (!isInPotentialCalculation
|| isBracketType(bracketTypeStack->back(), DEFINITION_TYPE)
|| (!isLegalNameChar(previousNonWSChar)
&& !(previousNonWSChar == ')' && nextChar == '(')
&& !(previousNonWSChar == ')' && currentChar == '*' && !isImmediatelyPostCast())
&& previousNonWSChar != ']')
);
if (!isPR)
{
isPR |= (!isWhiteSpace(nextChar)
&& nextChar != '-'
&& nextChar != '('
&& nextChar != '['
&& !isLegalNameChar(nextChar));
}
return isPR;
}
/**
* Check if the currently reached '*' or '&' character is
* a dereferenced pointer or "address of" symbol.
* NOTE: this MUST be a pointer or reference as determined by
* the function isPointerOrReference().
*
* @return whether current character is a dereference or address of
*/
bool ASFormatter::isDereferenceOrAddressOf() const
{
assert(currentChar == '*' || currentChar == '&' || currentChar == '^');
if (isCharImmediatelyPostTemplate)
return false;
if (previousNonWSChar == '='
|| previousNonWSChar == ','
|| previousNonWSChar == '.'
|| previousNonWSChar == '{'
|| previousNonWSChar == '>'
|| previousNonWSChar == '<'
|| isCharImmediatelyPostLineComment
|| isCharImmediatelyPostComment
|| isCharImmediatelyPostReturn)
return true;
// check for **
char nextChar = peekNextChar();
if (currentChar == '*' && nextChar == '*')
{
if (previousNonWSChar == '(')
return true;
if ((int) currentLine.length() < charNum + 2)
return true;
return false;
}
if (currentChar == '&' && nextChar == '&')
{
if (previousNonWSChar == '(' || templateDepth > 0)
return true;
if ((int) currentLine.length() < charNum + 2)
return true;
return false;
}
// check first char on the line
if (charNum == (int) currentLine.find_first_not_of(" \t")
&& (isBracketType(bracketTypeStack->back(), COMMAND_TYPE)
|| parenStack->back() != 0))
return true;
string nextText = peekNextText(currentLine.substr(charNum + 1));
if (nextText.length() > 0
&& (nextText[0] == ')' || nextText[0] == '>'
|| nextText[0] == ',' || nextText[0] == '='))
return false;
// check for reference to a pointer *& (cannot have &*)
if ((currentChar == '*' && nextChar == '&')
|| (previousNonWSChar == '*' && currentChar == '&'))
return false;
if (!isBracketType(bracketTypeStack->back(), COMMAND_TYPE)
&& parenStack->back() == 0)
return false;
string lastWord = getPreviousWord(currentLine, charNum);
if (lastWord == "else" || lastWord == "delete")
return true;
if (isPointerOrReferenceVariable(lastWord))
return false;
bool isDA = (!(isLegalNameChar(previousNonWSChar) || previousNonWSChar == '>')
|| (nextText.length() > 0 && !isLegalNameChar(nextText[0]) && nextText[0] != '/')
|| (ispunct((unsigned char)previousNonWSChar) && previousNonWSChar != '.')
|| isCharImmediatelyPostReturn);
return isDA;
}
/**
* Check if the currently reached '*' or '&' character is
* centered with one space on each side.
* Only spaces are checked, not tabs.
* If true then a space will be deleted on the output.
*
* @return whether current character is centered.
*/
bool ASFormatter::isPointerOrReferenceCentered() const
{
assert(currentLine[charNum] == '*' || currentLine[charNum] == '&' || currentLine[charNum] == '^');
int prNum = charNum;
int lineLength = (int) currentLine.length();
// check for end of line
if (peekNextChar() == ' ')
return false;
// check space before
if (prNum < 1
|| currentLine[prNum - 1] != ' ')
return false;
// check no space before that
if (prNum < 2
|| currentLine[prNum - 2] == ' ')
return false;
// check for **
if (prNum + 1 < lineLength
&& currentLine[prNum + 1] == '*')
prNum++;
// check space after
if (prNum + 1 <= lineLength
&& currentLine[prNum + 1] != ' ')
return false;
// check no space after that
if (prNum + 2 < lineLength
&& currentLine[prNum + 2] == ' ')
return false;
return true;
}
/**
* Check if a word is a pointer or reference variable type.
*
* @return whether word is a pointer or reference variable.
*/
bool ASFormatter::isPointerOrReferenceVariable(string &word) const
{
if (word == "char"
|| word == "int"
|| word == "void"
|| (word.length() >= 6 // check end of word for _t
&& word.compare(word.length() - 2, 2, "_t") == 0)
|| word == "INT"
|| word == "VOID")
return true;
return false;
}
/**
* check if the currently reached '+' or '-' character is a unary operator
* this method takes for granted that the current character
* is a '+' or '-'.
*
* @return whether the current '+' or '-' is a unary operator.
*/
bool ASFormatter::isUnaryOperator() const
{
assert(currentChar == '+' || currentChar == '-');
return ((isCharImmediatelyPostReturn || !isLegalNameChar(previousCommandChar))
&& previousCommandChar != '.'
&& previousCommandChar != '\"'
&& previousCommandChar != '\''
&& previousCommandChar != ')'
&& previousCommandChar != ']');
}
/**
* check if the currently reached comment is in a 'switch' statement
*
* @return whether the current '+' or '-' is in an exponent.
*/
bool ASFormatter::isInSwitchStatement() const
{
assert(isInLineComment || isInComment);
if (preBracketHeaderStack->size() > 0)
for (size_t i = 1; i < preBracketHeaderStack->size(); i++)
if (preBracketHeaderStack->at(i) == &AS_SWITCH)
return true;
return false;
}
/**
* check if the currently reached '+' or '-' character is
* part of an exponent, i.e. 0.2E-5.
*
* @return whether the current '+' or '-' is in an exponent.
*/
bool ASFormatter::isInExponent() const
{
assert(currentChar == '+' || currentChar == '-');
int formattedLineLength = formattedLine.length();
if (formattedLineLength >= 2)
{
char prevPrevFormattedChar = formattedLine[formattedLineLength - 2];
char prevFormattedChar = formattedLine[formattedLineLength - 1];
return ((prevFormattedChar == 'e' || prevFormattedChar == 'E')
&& (prevPrevFormattedChar == '.' || isDigit(prevPrevFormattedChar)));
}
else
return false;
}
/**
* check if an array bracket should NOT have an in-statement indent
*
* @return the array is non in-statement
*/
bool ASFormatter::isNonInStatementArrayBracket() const
{
bool returnVal = false;
char nextChar = peekNextChar();
// if this opening bracket begins the line there will be no inStatement indent
if (currentLineBeginsWithBracket
&& charNum == (int) currentLineFirstBracketNum
&& nextChar != '}')
returnVal = true;
// if an opening bracket ends the line there will be no inStatement indent
if (isWhiteSpace(nextChar)
|| isBeforeAnyLineEndComment(charNum)
|| nextChar == '{')
returnVal = true;
// Java "new Type [] {...}" IS an inStatement indent
if (isJavaStyle() && previousNonWSChar == ']')
returnVal = false;
return returnVal;
}
/**
* check if a one-line bracket has been reached,
* i.e. if the currently reached '{' character is closed
* with a complimentary '}' elsewhere on the current line,
*.
* @return 0 = one-line bracket has not been reached.
* 1 = one-line bracket has been reached.
* 2 = one-line bracket has been reached and is followed by a comma.
*/
int ASFormatter::isOneLineBlockReached(string &line, int startChar) const
{
assert(line[startChar] == '{');
bool isInComment_ = false;
bool isInQuote_ = false;
int bracketCount = 1;
int lineLength = line.length();
char quoteChar_ = ' ';
char ch = ' ';
char prevCh = ' ';
for (int i = startChar + 1; i < lineLength; ++i)
{
ch = line[i];
if (isInComment_)
{
if (line.compare(i, 2, "*/") == 0)
{
isInComment_ = false;
++i;
}
continue;
}
if (ch == '\\')
{
++i;
continue;
}
if (isInQuote_)
{
if (ch == quoteChar_)
isInQuote_ = false;
continue;
}
if (ch == '"' || ch == '\'')
{
isInQuote_ = true;
quoteChar_ = ch;
continue;
}
if (line.compare(i, 2, "//") == 0)
break;
if (line.compare(i, 2, "/*") == 0)
{
isInComment_ = true;
++i;
continue;
}
if (ch == '{')
++bracketCount;
else if (ch == '}')
--bracketCount;
if (bracketCount == 0)
{
// is this an array?
if (parenStack->back() == 0 && prevCh != '}')
{
size_t peekNum = line.find_first_not_of(" \t", i + 1);
if (peekNum != string::npos && line[peekNum] == ',')
return 2;
}
return 1;
}
if (!isWhiteSpace(ch))
prevCh = ch;
}
return 0;
}
/**
* peek at the next word to determine if it is a C# non-paren header.
* will look ahead in the input file if necessary.
*
* @param char position on currentLine to start the search
* @return true if the next word is get or set.
*/
bool ASFormatter::isNextWordSharpNonParenHeader(int startChar) const
{
// look ahead to find the next non-comment text
string nextText = peekNextText(currentLine.substr(startChar));
if (nextText.length() == 0)
return false;
if (nextText[0] == '[')
return true;
if (!isCharPotentialHeader(nextText, 0))
return false;
if (findKeyword(nextText, 0, AS_GET) || findKeyword(nextText, 0, AS_SET)
|| findKeyword(nextText, 0, AS_ADD) || findKeyword(nextText, 0, AS_REMOVE))
return true;
return false;
}
/**
* peek at the next char to determine if it is an opening bracket.
* will look ahead in the input file if necessary.
* this determines a java static constructor.
*
* @param char position on currentLine to start the search
* @return true if the next word is an opening bracket.
*/
bool ASFormatter::isNextCharOpeningBracket(int startChar) const
{
bool retVal = false;
string nextText = peekNextText(currentLine.substr(startChar));
if (nextText.length() > 0
&& nextText.compare(0, 1, "{") == 0)
retVal = true;
return retVal;
}
/**
* get the next non-whitespace substring on following lines, bypassing all comments.
*
* @param the first line to check
* @return the next non-whitespace substring.
*/
string ASFormatter::peekNextText(const string &firstLine, bool endOnEmptyLine /*false*/, bool shouldReset /*false*/) const
{
bool isFirstLine = true;
bool needReset = shouldReset;
string nextLine_ = firstLine;
size_t firstChar = string::npos;
// find the first non-blank text, bypassing all comments.
bool isInComment_ = false;
while (sourceIterator->hasMoreLines() || isFirstLine)
{
if (isFirstLine)
isFirstLine = false;
else
{
nextLine_ = sourceIterator->peekNextLine();
needReset = true;
}
firstChar = nextLine_.find_first_not_of(" \t");
if (firstChar == string::npos)
{
if (endOnEmptyLine && !isInComment_)
break;
continue;
}
if (nextLine_.compare(firstChar, 2, "/*") == 0)
{
firstChar += 2;
isInComment_ = true;
}
if (isInComment_)
{
firstChar = nextLine_.find("*/", firstChar);
if (firstChar == string::npos)
continue;
firstChar += 2;
isInComment_ = false;
firstChar = nextLine_.find_first_not_of(" \t", firstChar);
if (firstChar == string::npos)
continue;
}
if (nextLine_.compare(firstChar, 2, "//") == 0)
continue;
// found the next text
break;
}
if (firstChar == string::npos)
nextLine_ = "";
else
nextLine_ = nextLine_.substr(firstChar);
if (needReset)
sourceIterator->peekReset();
return nextLine_;
}
/**
* adjust comment position because of adding or deleting spaces
* the spaces are added or deleted to formattedLine
* spacePadNum contains the adjustment
*/
void ASFormatter::adjustComments(void)
{
assert(spacePadNum != 0);
assert(currentLine.compare(charNum, 2, "//") == 0
|| currentLine.compare(charNum, 2, "/*") == 0);
// block comment must be closed on this line with nothing after it
if (currentLine.compare(charNum, 2, "/*") == 0)
{
size_t endNum = currentLine.find("*/", charNum + 2);
if (endNum == string::npos)
return;
if (currentLine.find_first_not_of(" \t", endNum + 2) != string::npos)
return;
}
size_t len = formattedLine.length();
// don't adjust a tab
if (formattedLine[len - 1] == '\t')
return;
// if spaces were removed, need to add spaces before the comment
if (spacePadNum < 0)
{
int adjust = -spacePadNum; // make the number positive
formattedLine.append(adjust, ' ');
}
// if spaces were added, need to delete extra spaces before the comment
// if cannot be done put the comment one space after the last text
else if (spacePadNum > 0)
{
int adjust = spacePadNum;
size_t lastText = formattedLine.find_last_not_of(' ');
if (lastText != string::npos
&& lastText < len - adjust - 1)
formattedLine.resize(len - adjust);
else if (len > lastText + 2)
formattedLine.resize(lastText + 2);
else if (len < lastText + 2)
formattedLine.append(len - lastText, ' ');
}
}
/**
* append the current bracket inside the end of line comments
* currentChar contains the bracket, it will be appended to formattedLine
* formattedLineCommentNum is the comment location on formattedLine
*/
void ASFormatter::appendCharInsideComments(void)
{
if (formattedLineCommentNum == string::npos) // does the comment start on the previous line?
{
appendCurrentChar(); // don't attach
return;
}
assert(formattedLine.compare(formattedLineCommentNum, 2, "//") == 0
|| formattedLine.compare(formattedLineCommentNum, 2, "/*") == 0);
// find the previous non space char
size_t end = formattedLineCommentNum;
size_t beg = formattedLine.find_last_not_of(" \t", end - 1);
if (beg == string::npos)
{
appendCurrentChar(); // don't attach
return;
}
beg++;
// insert the bracket
if (end - beg < 3) // is there room to insert?
formattedLine.insert(beg, 3 - end + beg, ' ');
if (formattedLine[beg] == '\t') // don't pad with a tab
formattedLine.insert(beg, 1, ' ');
formattedLine[beg + 1] = currentChar;
testForTimeToSplitFormattedLine();
if (isBeforeComment())
breakLine();
else if (isCharImmediatelyPostLineComment)
shouldBreakLineAtNextChar = true;
return;
}
/**
* add or remove space padding to operators
* currentChar contains the paren
* the operators and necessary padding will be appended to formattedLine
* the calling function should have a continue statement after calling this method
*
* @param *newOperator the operator to be padded
*/
void ASFormatter::padOperators(const string* newOperator)
{
assert(shouldPadOperators);
assert(newOperator != NULL);
bool shouldPad = (newOperator != &AS_SCOPE_RESOLUTION
&& newOperator != &AS_PLUS_PLUS
&& newOperator != &AS_MINUS_MINUS
&& newOperator != &AS_NOT
&& newOperator != &AS_BIT_NOT
&& newOperator != &AS_ARROW
&& !(newOperator == &AS_COLON && !foundQuestionMark // objC methods
&& (isInObjCMethodDefinition || isInObjCInterface
|| isInObjCSelector || squareBracketCount))
&& !(newOperator == &AS_MINUS && isInExponent())
&& !((newOperator == &AS_PLUS || newOperator == &AS_MINUS) // check for unary plus or minus
&& (previousNonWSChar == '('
|| previousNonWSChar == '['
|| previousNonWSChar == '='
|| previousNonWSChar == ','))
&& !(newOperator == &AS_PLUS && isInExponent())
&& !isCharImmediatelyPostOperator
&& !((newOperator == &AS_MULT || newOperator == &AS_BIT_AND || newOperator == &AS_AND)
&& isPointerOrReference())
&& !(newOperator == &AS_MULT
&& (previousNonWSChar == '.'
|| previousNonWSChar == '>')) // check for ->
&& !((isInTemplate || isImmediatelyPostTemplate)
&& (newOperator == &AS_LS || newOperator == &AS_GR))
&& !(newOperator == &AS_GCC_MIN_ASSIGN
&& ASBase::peekNextChar(currentLine, charNum + 1) == '>')
&& !(newOperator == &AS_GR && previousNonWSChar == '?')
&& !(newOperator == &AS_QUESTION // check for Java wildcard
&& (previousNonWSChar == '<'
|| ASBase::peekNextChar(currentLine, charNum) == '>'
|| ASBase::peekNextChar(currentLine, charNum) == '.'))
&& !isInCase
&& !isInAsm
&& !isInAsmOneLine
&& !isInAsmBlock
);
// pad before operator
if (shouldPad
&& !(newOperator == &AS_COLON
&& (!foundQuestionMark && !isInEnum) && currentHeader != &AS_FOR)
&& !(newOperator == &AS_QUESTION && isSharpStyle() // check for C# nullable type (e.g. int?)
&& currentLine.find(':', charNum + 1) == string::npos)
)
appendSpacePad();
appendOperator(*newOperator);
goForward(newOperator->length() - 1);
currentChar = (*newOperator)[newOperator->length() - 1];
// pad after operator
// but do not pad after a '-' that is a unary-minus.
if (shouldPad
&& !isBeforeAnyComment()
&& !(newOperator == &AS_PLUS && isUnaryOperator())
&& !(newOperator == &AS_MINUS && isUnaryOperator())
&& !(currentLine.compare(charNum + 1, 1, AS_SEMICOLON) == 0)
&& !(currentLine.compare(charNum + 1, 2, AS_SCOPE_RESOLUTION) == 0)
&& !(peekNextChar() == ',')
&& !(newOperator == &AS_QUESTION && isSharpStyle() // check for C# nullable type (e.g. int?)
&& peekNextChar() == '[')
)
appendSpaceAfter();
previousOperator = newOperator;
return;
}
/**
* format pointer or reference
* currentChar contains the pointer or reference
* the symbol and necessary padding will be appended to formattedLine
* the calling function should have a continue statement after calling this method
*
* NOTE: Do NOT use appendCurrentChar() in this method. The line should not be
* broken once the calculation starts.
*/
void ASFormatter::formatPointerOrReference(void)
{
assert(currentChar == '*' || currentChar == '&' || currentChar == '^');
assert(!isJavaStyle());
int pa = pointerAlignment;
int ra = referenceAlignment;
int itemAlignment = (currentChar == '*' || currentChar == '^') ? pa : ((ra == REF_SAME_AS_PTR) ? pa : ra);
// check for **
char peekedChar = peekNextChar();
if (currentChar == '*' && peekedChar == '*')
{
// remove any spaces between * and * (compiles OK if there are)
if (currentLine[charNum + 1] != '*')
{
size_t nextPointer = currentLine.find_first_not_of(" \t", charNum + 1);
assert(nextPointer != string::npos && currentLine[nextPointer] == '*');
currentLine.erase(charNum + 1, nextPointer - (charNum + 1));
}
size_t nextChar = currentLine.find_first_not_of(" \t", charNum + 2);
if (nextChar == string::npos)
peekedChar = ' ';
else
peekedChar = currentLine[nextChar];
}
if (currentChar == '&' && peekedChar == '&')
{
size_t nextChar = currentLine.find_first_not_of(" \t", charNum + 2);
if (nextChar == string::npos)
peekedChar = ' ';
else
peekedChar = currentLine[nextChar];
}
// check for cast
if (peekedChar == ')' || peekedChar == '>' || peekedChar == ',')
{
formatPointerOrReferenceCast();
return;
}
// check for a padded space and remove it
if (charNum > 0
&& !isWhiteSpace(currentLine[charNum - 1])
&& formattedLine.length() > 0
&& isWhiteSpace(formattedLine[formattedLine.length() - 1]))
{
formattedLine.erase(formattedLine.length() - 1);
spacePadNum--;
}
if (itemAlignment == PTR_ALIGN_TYPE)
{
formatPointerOrReferenceToType();
}
else if (itemAlignment == PTR_ALIGN_MIDDLE)
{
formatPointerOrReferenceToMiddle();
}
else if (itemAlignment == PTR_ALIGN_NAME)
{
formatPointerOrReferenceToName();
}
else // pointerAlignment == PTR_ALIGN_NONE
{
formattedLine.append(1, currentChar);
}
}
/**
* format pointer or reference with align to type
*/
void ASFormatter::formatPointerOrReferenceToType()
{
assert(currentChar == '*' || currentChar == '&' || currentChar == '^');
assert(!isJavaStyle());
// do this before bumping charNum
bool isOldPRCentered = isPointerOrReferenceCentered();
size_t prevCh = formattedLine.find_last_not_of(" \t");
if (prevCh == string::npos)
prevCh = 0;
if (formattedLine.length() == 0 || prevCh == formattedLine.length() - 1)
formattedLine.append(1, currentChar);
else
{
// exchange * or & with character following the type
// this may not work every time with a tab character
string charSave = formattedLine.substr(prevCh + 1, 1);
formattedLine[prevCh + 1] = currentChar;
formattedLine.append(charSave);
}
if (isSequenceReached("**") || isSequenceReached("&&"))
{
if (formattedLine.length() == 1)
formattedLine.append(1, currentChar);
else
formattedLine.insert(prevCh + 2, 1, currentChar);
goForward(1);
}
// if no space after then add one
if (charNum < (int) currentLine.length() - 1
&& !isWhiteSpace(currentLine[charNum + 1])
&& currentLine[charNum + 1] != ')')
appendSpacePad();
// if old pointer or reference is centered, remove a space
if (isOldPRCentered
&& isWhiteSpace(formattedLine[formattedLine.length() - 1]))
{
formattedLine.erase(formattedLine.length() - 1, 1);
spacePadNum--;
}
// update the formattedLine split point
if (maxCodeLength != string::npos)
{
size_t index = formattedLine.length() - 1;
if (isWhiteSpace(formattedLine[index]))
{
updateFormattedLineSplitPointsPointerOrReference(index);
testForTimeToSplitFormattedLine();
}
}
}
/**
* format pointer or reference with align in the middle
*/
void ASFormatter::formatPointerOrReferenceToMiddle()
{
assert(currentChar == '*' || currentChar == '&' || currentChar == '^');
assert(!isJavaStyle());
// compute current whitespace before
size_t wsBefore = currentLine.find_last_not_of(" \t", charNum - 1);
if (wsBefore == string::npos)
wsBefore = 0;
else
wsBefore = charNum - wsBefore - 1;
string sequenceToInsert(1, currentChar);
if (isSequenceReached("**"))
{
sequenceToInsert = "**";
goForward(1);
}
else if (isSequenceReached("&&"))
{
sequenceToInsert = "&&";
goForward(1);
}
// if reference to a pointer check for conflicting alignment
else if (currentChar == '*' && peekNextChar() == '&'
&& (referenceAlignment == REF_ALIGN_TYPE
|| referenceAlignment == REF_ALIGN_MIDDLE
|| referenceAlignment == REF_SAME_AS_PTR))
{
sequenceToInsert = "*&";
goForward(1);
for (size_t i = charNum; i < currentLine.length() - 1 && isWhiteSpace(currentLine[i]); i++)
goForward(1);
}
// if a comment follows don't align, just space pad
if (isBeforeAnyComment())
{
appendSpacePad();
formattedLine.append(sequenceToInsert);
appendSpaceAfter();
return;
}
// do this before goForward()
bool isAfterScopeResolution = previousNonWSChar == ':';
size_t charNumSave = charNum;
// if this is the last thing on the line
if (currentLine.find_first_not_of(" \t", charNum + 1) == string::npos)
{
if (wsBefore == 0 && !isAfterScopeResolution)
{
wsBefore = 1;
formattedLine.append(1, ' ');
}
formattedLine.append(sequenceToInsert);
return;
}
// goForward() to convert tabs to spaces, if necessary,
// and move following characters to preceding characters
// this may not work every time with tab characters
for (size_t i = charNum + 1; i < currentLine.length() && isWhiteSpace(currentLine[i]); i++)
{
goForward(1);
if (formattedLine.length() > 0)
formattedLine.append(1, currentLine[i]);
else
spacePadNum--;
}
// find space padding after
size_t wsAfter = currentLine.find_first_not_of(" \t", charNumSave + 1);
if (wsAfter == string::npos || isBeforeAnyComment())
wsAfter = 0;
else
wsAfter = wsAfter - charNumSave - 1;
// don't pad before scope resolution operator, but pad after
if (isAfterScopeResolution)
{
size_t lastText = formattedLine.find_last_not_of(" \t");
formattedLine.insert(lastText + 1, sequenceToInsert);
appendSpacePad();
}
else if (formattedLine.length() > 0)
{
// whitespace should be at least 2 chars to center
if (wsBefore + wsAfter < 2)
{
size_t charsToAppend = (2 - (wsBefore + wsAfter));
formattedLine.append(charsToAppend, ' ');
spacePadNum += charsToAppend;
if (wsBefore == 0) wsBefore++;
if (wsAfter == 0) wsAfter++;
}
// insert the pointer or reference char
size_t padAfter = (wsBefore + wsAfter) / 2;
size_t index = formattedLine.length() - padAfter;
formattedLine.insert(index, sequenceToInsert);
}
else // formattedLine.length() == 0
{
formattedLine.append(sequenceToInsert);
if (wsAfter == 0)
wsAfter++;
formattedLine.append(wsAfter, ' ');
spacePadNum += wsAfter;
}
// update the formattedLine split point after the pointer
if (maxCodeLength != string::npos && formattedLine.length() > 0)
{
size_t index = formattedLine.find_last_not_of(" \t");
if (index != string::npos && (index < formattedLine.length() - 1))
{
index++;
updateFormattedLineSplitPointsPointerOrReference(index);
testForTimeToSplitFormattedLine();
}
}
}
/**
* format pointer or reference with align to name
*/
void ASFormatter::formatPointerOrReferenceToName()
{
assert(currentChar == '*' || currentChar == '&' || currentChar == '^');
assert(!isJavaStyle());
// do this before bumping charNum
bool isOldPRCentered = isPointerOrReferenceCentered();
size_t startNum = formattedLine.find_last_not_of(" \t");
if (startNum == string::npos)
startNum = 0;
string sequenceToInsert(1, currentChar);
if (isSequenceReached("**"))
{
sequenceToInsert = "**";
goForward(1);
}
else if (isSequenceReached("&&"))
{
sequenceToInsert = "&&";
goForward(1);
}
// if reference to a pointer align both to name
else if (currentChar == '*' && peekNextChar() == '&')
{
sequenceToInsert = "*&";
goForward(1);
for (size_t i = charNum; i < currentLine.length() - 1 && isWhiteSpace(currentLine[i]); i++)
goForward(1);
}
char peekedChar = peekNextChar();
bool isAfterScopeResolution = previousNonWSChar == ':'; // check for ::
// if this is not the last thing on the line
if (!isBeforeAnyComment()
&& (int) currentLine.find_first_not_of(" \t", charNum + 1) > charNum)
{
// goForward() to convert tabs to spaces, if necessary,
// and move following characters to preceding characters
// this may not work every time with tab characters
for (size_t i = charNum + 1; i < currentLine.length() && isWhiteSpace(currentLine[i]); i++)
{
// if a padded paren follows don't move
if (shouldPadParensOutside && peekedChar == '(' && !isOldPRCentered)
{
// empty parens don't count
size_t start = currentLine.find_first_not_of("( \t", charNum + 1);
if (start != string::npos && currentLine[start] != ')')
break;
}
goForward(1);
if (formattedLine.length() > 0)
formattedLine.append(1, currentLine[i]);
else
spacePadNum--;
}
}
// don't pad before scope resolution operator
if (isAfterScopeResolution)
{
size_t lastText = formattedLine.find_last_not_of(" \t");
if (lastText != string::npos && lastText + 1 < formattedLine.length())
formattedLine.erase(lastText + 1);
}
// if no space before * then add one
else if (formattedLine.length() > 0
&& (formattedLine.length() <= startNum + 1
|| !isWhiteSpace(formattedLine[startNum + 1])))
{
formattedLine.insert(startNum + 1 , 1, ' ');
spacePadNum++;
}
appendSequence(sequenceToInsert, false);
// if old pointer or reference is centered, remove a space
if (isOldPRCentered
&& formattedLine.length() > startNum + 1
&& isWhiteSpace(formattedLine[startNum + 1])
&& !isBeforeAnyComment())
{
formattedLine.erase(startNum + 1, 1);
spacePadNum--;
}
// don't convert to *= or &=
if (peekedChar == '=')
{
appendSpaceAfter();
// if more than one space before, delete one
if (formattedLine.length() > startNum
&& isWhiteSpace(formattedLine[startNum + 1])
&& isWhiteSpace(formattedLine[startNum + 2]))
{
formattedLine.erase(startNum + 1, 1);
spacePadNum--;
}
}
// update the formattedLine split point
if (maxCodeLength != string::npos)
{
size_t index = formattedLine.find_last_of(" \t");
if (index != string::npos
&& index < formattedLine.length() - 1
&& (formattedLine[index + 1] == '*'
|| formattedLine[index + 1] == '&'
|| formattedLine[index + 1] == '^'))
{
updateFormattedLineSplitPointsPointerOrReference(index);
testForTimeToSplitFormattedLine();
}
}
}
/**
* format pointer or reference cast
* currentChar contains the pointer or reference
* NOTE: the pointers and references in function definitions
* are processed as a cast (e.g. void foo(void*, void*))
* is processed here.
*/
void ASFormatter::formatPointerOrReferenceCast(void)
{
assert(currentChar == '*' || currentChar == '&' || currentChar == '^');
assert(!isJavaStyle());
int pa = pointerAlignment;
int ra = referenceAlignment;
int itemAlignment = (currentChar == '*' || currentChar == '^') ? pa : ((ra == REF_SAME_AS_PTR) ? pa : ra);
string sequenceToInsert(1, currentChar);
if (isSequenceReached("**") || isSequenceReached("&&"))
{
goForward(1);
sequenceToInsert.append(1, currentLine[charNum]);
}
if (itemAlignment == PTR_ALIGN_NONE)
{
appendSequence(sequenceToInsert, false);
return;
}
// remove preceding whitespace
char prevCh = ' ';
size_t prevNum = formattedLine.find_last_not_of(" \t");
if (prevNum != string::npos)
{
prevCh = formattedLine[prevNum];
if (prevNum + 1 < formattedLine.length()
&& isWhiteSpace(formattedLine[prevNum + 1])
&& prevCh != '(')
{
spacePadNum -= (formattedLine.length() - 1 - prevNum);
formattedLine.erase(prevNum + 1);
}
}
bool isAfterScopeResolution = previousNonWSChar == ':';
if ((itemAlignment == PTR_ALIGN_MIDDLE || itemAlignment == PTR_ALIGN_NAME)
&& !isAfterScopeResolution && prevCh != '(')
{
appendSpacePad();
// in this case appendSpacePad may or may not update the split point
if (maxCodeLength != string::npos && formattedLine.length() > 0)
updateFormattedLineSplitPointsPointerOrReference(formattedLine.length() - 1);
appendSequence(sequenceToInsert, false);
}
else
appendSequence(sequenceToInsert, false);
// remove trailing whitespace if paren or comma follow
char nextChar = peekNextChar();
if (nextChar == ')' || nextChar == ',')
{
while (isWhiteSpace(currentLine[charNum + 1]))
{
goForward(1);
spacePadNum--;
}
}
}
/**
* add or remove space padding to parens
* currentChar contains the paren
* the parens and necessary padding will be appended to formattedLine
* the calling function should have a continue statement after calling this method
*/
void ASFormatter::padParens(void)
{
assert(shouldPadParensOutside || shouldPadParensInside || shouldUnPadParens || shouldPadFirstParen);
assert(currentChar == '(' || currentChar == ')');
int spacesOutsideToDelete = 0;
int spacesInsideToDelete = 0;
if (currentChar == '(')
{
spacesOutsideToDelete = formattedLine.length() - 1;
spacesInsideToDelete = 0;
// compute spaces outside the opening paren to delete
if (shouldUnPadParens)
{
char lastChar = ' ';
bool prevIsParenHeader = false;
size_t i = formattedLine.find_last_not_of(" \t");
if (i != string::npos)
{
// if last char is a bracket the previous whitespace is an indent
if (formattedLine[i] == '{')
spacesOutsideToDelete = 0;
else if (isCharImmediatelyPostPointerOrReference)
spacesOutsideToDelete = 0;
else
{
spacesOutsideToDelete -= i;
lastChar = formattedLine[i];
// if previous word is a header, it will be a paren header
string prevWord = getPreviousWord(formattedLine, formattedLine.length());
const string* prevWordH = NULL;
if (shouldPadHeader
&& prevWord.length() > 0
&& isCharPotentialHeader(prevWord, 0))
prevWordH = ASBeautifier::findHeader(prevWord, 0, headers);
if (prevWordH != NULL)
prevIsParenHeader = true;
else if (prevWord == "return") // don't unpad
prevIsParenHeader = true;
else if (isCStyle() && prevWord == "throw" && shouldPadHeader) // don't unpad
prevIsParenHeader = true;
else if (prevWord == "and" || prevWord == "or") // don't unpad
prevIsParenHeader = true;
// don't unpad variables
else if (prevWord == "bool"
|| prevWord == "int"
|| prevWord == "void"
|| prevWord == "void*"
|| (prevWord.length() >= 6 // check end of word for _t
&& prevWord.compare(prevWord.length() - 2, 2, "_t") == 0)
|| prevWord == "BOOL"
|| prevWord == "DWORD"
|| prevWord == "HWND"
|| prevWord == "INT"
|| prevWord == "LPSTR"
|| prevWord == "VOID"
|| prevWord == "LPVOID"
)
{
prevIsParenHeader = true;
}
}
}
// do not unpad operators, but leave them if already padded
if (shouldPadParensOutside || prevIsParenHeader)
spacesOutsideToDelete--;
else if (lastChar == '|' // check for ||
|| lastChar == '&' // check for &&
|| lastChar == ','
|| (lastChar == '(' && shouldPadParensInside)
|| (lastChar == '>' && !foundCastOperator)
|| lastChar == '<'
|| lastChar == '?'
|| lastChar == ':'
|| lastChar == ';'
|| lastChar == '='
|| lastChar == '+'
|| lastChar == '-'
|| lastChar == '*'
|| lastChar == '/'
|| lastChar == '%'
|| lastChar == '^'
)
spacesOutsideToDelete--;
if (spacesOutsideToDelete > 0)
{
formattedLine.erase(i + 1, spacesOutsideToDelete);
spacePadNum -= spacesOutsideToDelete;
}
}
// pad open paren outside
char peekedCharOutside = peekNextChar();
if (shouldPadFirstParen && previousChar != '(' && peekedCharOutside != ')')
appendSpacePad();
else if (shouldPadParensOutside)
{
if (!(currentChar == '(' && peekedCharOutside == ')'))
appendSpacePad();
}
appendCurrentChar();
// unpad open paren inside
if (shouldUnPadParens)
{
size_t j = currentLine.find_first_not_of(" \t", charNum + 1);
if (j != string::npos)
spacesInsideToDelete = j - charNum - 1;
if (shouldPadParensInside)
spacesInsideToDelete--;
if (spacesInsideToDelete > 0)
{
currentLine.erase(charNum + 1, spacesInsideToDelete);
spacePadNum -= spacesInsideToDelete;
}
// convert tab to space if requested
if (shouldConvertTabs
&& (int)currentLine.length() > charNum + 1
&& currentLine[charNum + 1] == '\t')
currentLine[charNum + 1] = ' ';
}
// pad open paren inside
char peekedCharInside = peekNextChar();
if (shouldPadParensInside)
if (!(currentChar == '(' && peekedCharInside == ')'))
appendSpaceAfter();
}
else if (currentChar == ')')
{
spacesOutsideToDelete = 0;
spacesInsideToDelete = formattedLine.length();
// unpad close paren inside
if (shouldUnPadParens)
{
size_t i = formattedLine.find_last_not_of(" \t");
if (i != string::npos)
spacesInsideToDelete = formattedLine.length() - 1 - i;
if (shouldPadParensInside)
spacesInsideToDelete--;
if (spacesInsideToDelete > 0)
{
formattedLine.erase(i + 1, spacesInsideToDelete);
spacePadNum -= spacesInsideToDelete;
}
}
// pad close paren inside
if (shouldPadParensInside)
if (!(previousChar == '(' && currentChar == ')'))
appendSpacePad();
appendCurrentChar();
// unpad close paren outside
// close parens outside are left unchanged
if (shouldUnPadParens)
{
//size_t j = currentLine.find_first_not_of(" \t", charNum + 1);
//if (j != string::npos)
// spacesOutsideToDelete = j - charNum - 1;
//if (shouldPadParensOutside)
// spacesOutsideToDelete--;
//if (spacesOutsideToDelete > 0)
//{
// currentLine.erase(charNum + 1, spacesOutsideToDelete);
// spacePadNum -= spacesOutsideToDelete;
//}
}
// pad close paren outside
char peekedCharOutside = peekNextChar();
if (shouldPadParensOutside)
if (peekedCharOutside != ';'
&& peekedCharOutside != ','
&& peekedCharOutside != '.'
&& peekedCharOutside != '+' // check for ++
&& peekedCharOutside != '-' // check for --
&& peekedCharOutside != ']')
appendSpaceAfter();
}
return;
}
/**
* format opening bracket as attached or broken
* currentChar contains the bracket
* the brackets will be appended to the current formattedLine or a new formattedLine as necessary
* the calling function should have a continue statement after calling this method
*
* @param bracketType the type of bracket to be formatted.
*/
void ASFormatter::formatOpeningBracket(BracketType bracketType)
{
assert(!isBracketType(bracketType, ARRAY_TYPE));
assert(currentChar == '{');
parenStack->push_back(0);
bool breakBracket = isCurrentBracketBroken();
if (breakBracket)
{
if (isBeforeAnyComment() && isOkToBreakBlock(bracketType))
{
// if comment is at line end leave the comment on this line
if (isBeforeAnyLineEndComment(charNum) && !currentLineBeginsWithBracket)
{
currentChar = ' '; // remove bracket from current line
if (parenStack->size() > 1)
parenStack->pop_back();
currentLine[charNum] = currentChar;
appendOpeningBracket = true; // append bracket to following line
}
// else put comment after the bracket
else if (!isBeforeMultipleLineEndComments(charNum))
breakLine();
}
else if (!isBracketType(bracketType, SINGLE_LINE_TYPE))
breakLine();
else if (shouldBreakOneLineBlocks && peekNextChar() != '}')
breakLine();
else if (!isInLineBreak)
appendSpacePad();
appendCurrentChar();
// should a following comment break from the bracket?
// must break the line AFTER the bracket
if (isBeforeComment()
&& formattedLine.length() > 0
&& formattedLine[0] == '{'
&& isOkToBreakBlock(bracketType)
&& (bracketFormatMode == BREAK_MODE
|| bracketFormatMode == LINUX_MODE
|| bracketFormatMode == STROUSTRUP_MODE))
{
shouldBreakLineAtNextChar = true;
}
}
else // attach bracket
{
// are there comments before the bracket?
if (isCharImmediatelyPostComment || isCharImmediatelyPostLineComment)
{
if (isOkToBreakBlock(bracketType)
&& !(isCharImmediatelyPostComment && isCharImmediatelyPostLineComment) // don't attach if two comments on the line
&& !isImmediatelyPostPreprocessor
// && peekNextChar() != '}' // don't attach { } // removed release 2.03
&& previousCommandChar != '{' // don't attach { {
&& previousCommandChar != '}' // don't attach } {
&& previousCommandChar != ';') // don't attach ; {
{
appendCharInsideComments();
}
else
{
appendCurrentChar(); // don't attach
}
}
else if (previousCommandChar == '{'
|| previousCommandChar == '}'
|| previousCommandChar == ';') // '}' , ';' chars added for proper handling of '{' immediately after a '}' or ';'
{
appendCurrentChar(); // don't attach
}
else
{
// if a blank line precedes this don't attach
if (isEmptyLine(formattedLine))
appendCurrentChar(); // don't attach
else if (isOkToBreakBlock(bracketType)
&& !(isImmediatelyPostPreprocessor
&& currentLineBeginsWithBracket))
{
if (peekNextChar() != '}')
{
appendSpacePad();
appendCurrentChar(false); // OK to attach
testForTimeToSplitFormattedLine(); // line length will have changed
// should a following comment attach with the bracket?
// insert spaces to reposition the comment
if (isBeforeComment()
&& !isBeforeMultipleLineEndComments(charNum)
&& (!isBeforeAnyLineEndComment(charNum) || currentLineBeginsWithBracket))
{
shouldBreakLineAtNextChar = true;
currentLine.insert(charNum + 1, charNum + 1, ' ');
}
else if (!isBeforeAnyComment()) // added in release 2.03
{
shouldBreakLineAtNextChar = true;
}
}
else
{
if (currentLineBeginsWithBracket && charNum == (int) currentLineFirstBracketNum)
{
appendSpacePad();
appendCurrentChar(false); // attach
shouldBreakLineAtNextChar = true;
}
else
{
appendSpacePad();
appendCurrentChar(); // don't attach
}
}
}
else
{
if (!isInLineBreak)
appendSpacePad();
appendCurrentChar(); // don't attach
}
}
}
}
/**
* format closing bracket
* currentChar contains the bracket
* the calling function should have a continue statement after calling this method
*
* @param bracketType the type of the opening bracket for this closing bracket.
*/
void ASFormatter::formatClosingBracket(BracketType bracketType)
{
assert(!isBracketType(bracketType, ARRAY_TYPE));
assert(currentChar == '}');
// parenStack must contain one entry
if (parenStack->size() > 1)
parenStack->pop_back();
// mark state of immediately after empty block
// this state will be used for locating brackets that appear immediately AFTER an empty block (e.g. '{} \n}').
if (previousCommandChar == '{')
isImmediatelyPostEmptyBlock = true;
if (shouldAttachClosingBracket)
{
// for now, namespaces and classes will be attached. Uncomment the lines below to break.
if ((isEmptyLine(formattedLine) // if a blank line precedes this
|| isCharImmediatelyPostLineComment
|| isCharImmediatelyPostComment
|| (isImmediatelyPostPreprocessor && (int) currentLine.find_first_not_of(" \t") == charNum)
// || (isBracketType(bracketType, CLASS_TYPE) && isOkToBreakBlock(bracketType) && previousNonWSChar != '{')
// || (isBracketType(bracketType, NAMESPACE_TYPE) && isOkToBreakBlock(bracketType) && previousNonWSChar != '{')
)
&& (!isBracketType(bracketType, SINGLE_LINE_TYPE) || isOkToBreakBlock(bracketType)))
{
breakLine();
appendCurrentChar(); // don't attach
}
else
{
if (previousNonWSChar != '{'
&& (!isBracketType(bracketType, SINGLE_LINE_TYPE) || isOkToBreakBlock(bracketType)))
appendSpacePad();
appendCurrentChar(false); // attach
}
}
else if ((!(previousCommandChar == '{' && isPreviousBracketBlockRelated)) // this '}' does not close an empty block
&& isOkToBreakBlock(bracketType)) // astyle is allowed to break one line blocks
{
breakLine();
appendCurrentChar();
}
else
{
appendCurrentChar();
}
// if a declaration follows a definition, space pad
if (isLegalNameChar(peekNextChar()))
appendSpaceAfter();
if (shouldBreakBlocks
&& currentHeader != NULL
&& !isHeaderInMultiStatementLine
&& parenStack->back() == 0)
{
if (currentHeader == &AS_CASE || currentHeader == &AS_DEFAULT)
{
// do not yet insert a line if "break" statement is outside the brackets
string nextText = peekNextText(currentLine.substr(charNum + 1));
if (nextText.length() > 0
&& nextText.substr(0, 5) != "break")
isAppendPostBlockEmptyLineRequested = true;
}
else
isAppendPostBlockEmptyLineRequested = true;
}
}
/**
* format array brackets as attached or broken
* determine if the brackets can have an inStatement indent
* currentChar contains the bracket
* the brackets will be appended to the current formattedLine or a new formattedLine as necessary
* the calling function should have a continue statement after calling this method
*
* @param bracketType the type of bracket to be formatted, must be an ARRAY_TYPE.
* @param isOpeningArrayBracket indicates if this is the opening bracket for the array block.
*/
void ASFormatter::formatArrayBrackets(BracketType bracketType, bool isOpeningArrayBracket)
{
assert(isBracketType(bracketType, ARRAY_TYPE));
assert(currentChar == '{' || currentChar == '}');
if (currentChar == '{')
{
// is this the first opening bracket in the array?
if (isOpeningArrayBracket)
{
if (bracketFormatMode == ATTACH_MODE
|| bracketFormatMode == LINUX_MODE
|| bracketFormatMode == STROUSTRUP_MODE)
{
// don't attach to a preprocessor directive or '\' line
if ((isImmediatelyPostPreprocessor
|| (formattedLine.length() > 0
&& formattedLine[formattedLine.length() - 1] == '\\'))
&& currentLineBeginsWithBracket)
{
isInLineBreak = true;
appendCurrentChar(); // don't attach
}
else if (isCharImmediatelyPostComment)
{
// TODO: attach bracket to line-end comment
appendCurrentChar(); // don't attach
}
else if (isCharImmediatelyPostLineComment && !isBracketType(bracketType, SINGLE_LINE_TYPE))
{
appendCharInsideComments();
}
else
{
// if a blank line precedes this don't attach
if (isEmptyLine(formattedLine))
appendCurrentChar(); // don't attach
else
{
// if bracket is broken or not an assignment
if (currentLineBeginsWithBracket
&& !isBracketType(bracketType, SINGLE_LINE_TYPE))
{
appendSpacePad();
appendCurrentChar(false); // OK to attach
// TODO: debug the following line
testForTimeToSplitFormattedLine(); // line length will have changed
if (currentLineBeginsWithBracket
&& (int)currentLineFirstBracketNum == charNum)
shouldBreakLineAtNextChar = true;
}
else
{
if (previousNonWSChar != '(')
appendSpacePad();
appendCurrentChar();
}
}
}
}
else if (bracketFormatMode == BREAK_MODE)
{
if (isWhiteSpace(peekNextChar()))
breakLine();
else if (isBeforeAnyComment())
{
// do not break unless comment is at line end
if (isBeforeAnyLineEndComment(charNum) && !currentLineBeginsWithBracket)
{
currentChar = ' '; // remove bracket from current line
appendOpeningBracket = true; // append bracket to following line
}
}
if (!isInLineBreak && previousNonWSChar != '(')
appendSpacePad();
appendCurrentChar();
if (currentLineBeginsWithBracket
&& (int)currentLineFirstBracketNum == charNum
&& !isBracketType(bracketType, SINGLE_LINE_TYPE))
shouldBreakLineAtNextChar = true;
}
else if (bracketFormatMode == RUN_IN_MODE)
{
if (isWhiteSpace(peekNextChar()))
breakLine();
else if (isBeforeAnyComment())
{
// do not break unless comment is at line end
if (isBeforeAnyLineEndComment(charNum) && !currentLineBeginsWithBracket)
{
currentChar = ' '; // remove bracket from current line
appendOpeningBracket = true; // append bracket to following line
}
}
if (!isInLineBreak && previousNonWSChar != '(')
appendSpacePad();
appendCurrentChar();
}
else if (bracketFormatMode == NONE_MODE)
{
if (currentLineBeginsWithBracket
&& charNum == (int) currentLineFirstBracketNum)
{
appendCurrentChar(); // don't attach
}
else
{
if (previousNonWSChar != '(')
appendSpacePad();
appendCurrentChar(false); // OK to attach
}
}
}
else // not the first opening bracket
{
if (bracketFormatMode == RUN_IN_MODE)
{
if (previousNonWSChar == '{'
&& bracketTypeStack->size() > 2
&& !isBracketType((*bracketTypeStack)[bracketTypeStack->size() - 2], SINGLE_LINE_TYPE))
formatArrayRunIn();
}
else if (!isInLineBreak
&& !isWhiteSpace(peekNextChar())
&& previousNonWSChar == '{'
&& bracketTypeStack->size() > 2
&& !isBracketType((*bracketTypeStack)[bracketTypeStack->size() - 2], SINGLE_LINE_TYPE))
formatArrayRunIn();
appendCurrentChar();
}
}
else if (currentChar == '}')
{
if (shouldAttachClosingBracket)
{
if (isEmptyLine(formattedLine) // if a blank line precedes this
|| isImmediatelyPostPreprocessor
|| isCharImmediatelyPostLineComment
|| isCharImmediatelyPostComment)
appendCurrentChar(); // don't attach
else
{
appendSpacePad();
appendCurrentChar(false); // attach
}
}
else
{
// does this close the first opening bracket in the array?
// must check if the block is still a single line because of anonymous statements
if (!isBracketType(bracketType, SINGLE_LINE_TYPE)
|| formattedLine.find('{') == string::npos)
breakLine();
appendCurrentChar();
}
// if a declaration follows an enum definition, space pad
char peekedChar = peekNextChar();
if (isLegalNameChar(peekedChar)
|| peekedChar == '[')
appendSpaceAfter();
}
}
/**
* determine if a run-in can be attached.
* if it can insert the indents in formattedLine and reset the current line break.
*/
void ASFormatter::formatRunIn()
{
assert(bracketFormatMode == RUN_IN_MODE || bracketFormatMode == NONE_MODE);
// keep one line blocks returns true without indenting the run-in
if (!isOkToBreakBlock(bracketTypeStack->back()))
return; // true;
// make sure the line begins with a bracket
size_t lastText = formattedLine.find_last_not_of(" \t");
if (lastText == string::npos || formattedLine[lastText] != '{')
return; // false;
// make sure the bracket is broken
if (formattedLine.find_first_not_of(" \t{") != string::npos)
return; // false;
if (isBracketType(bracketTypeStack->back(), NAMESPACE_TYPE))
return; // false;
bool extraIndent = false;
isInLineBreak = true;
// cannot attach a class modifier without indent-classes
if (isCStyle()
&& isCharPotentialHeader(currentLine, charNum)
&& (isBracketType(bracketTypeStack->back(), CLASS_TYPE)
|| (isBracketType(bracketTypeStack->back(), STRUCT_TYPE)
&& isInIndentableStruct)))
{
if (findKeyword(currentLine, charNum, AS_PUBLIC)
|| findKeyword(currentLine, charNum, AS_PRIVATE)
|| findKeyword(currentLine, charNum, AS_PROTECTED))
{
if (!getClassIndent())
return; // false;
}
else if (getClassIndent())
extraIndent = true;
}
// cannot attach a 'case' statement without indent-switches
if (!getSwitchIndent()
&& isCharPotentialHeader(currentLine, charNum)
&& (findKeyword(currentLine, charNum, AS_CASE)
|| findKeyword(currentLine, charNum, AS_DEFAULT)))
return; // false;
// extra indent for switch statements
if (getSwitchIndent()
&& !preBracketHeaderStack->empty()
&& preBracketHeaderStack->back() == &AS_SWITCH
&& ((isLegalNameChar(currentChar)
&& !findKeyword(currentLine, charNum, AS_CASE))))
extraIndent = true;
isInLineBreak = false;
// remove for extra whitespace
if (formattedLine.length() > lastText + 1
&& formattedLine.find_first_not_of(" \t", lastText + 1) == string::npos)
formattedLine.erase(lastText + 1);
if (getForceTabIndentation() && getIndentLength() != getTabLength())
{
// insert the space indents
string indent;
int indentLength_ = getIndentLength();
int tabLength_ = getTabLength();
indent.append(indentLength_, ' ');
if (extraIndent)
indent.append(indentLength_, ' ');
// replace spaces indents with tab indents
size_t tabCount = indent.length() / tabLength_; // truncate extra spaces
indent.erase(0U, tabCount * tabLength_);
indent.insert(0U, tabCount, '\t');
horstmannIndentChars = indentLength_;
if (indent[0] == ' ') // allow for bracket
indent.erase(0, 1);
formattedLine.append(indent);
}
else if (getIndentString() == "\t")
{
appendChar('\t', false);
horstmannIndentChars = 2; // one for { and one for tab
if (extraIndent)
{
appendChar('\t', false);
horstmannIndentChars++;
}
}
else // spaces
{
int indentLength_ = getIndentLength();
formattedLine.append(indentLength_ - 1, ' ');
horstmannIndentChars = indentLength_;
if (extraIndent)
{
formattedLine.append(indentLength_, ' ');
horstmannIndentChars += indentLength_;
}
}
isInHorstmannRunIn = true;
}
/**
* remove whitepace and add indentation for an array run-in.
*/
void ASFormatter::formatArrayRunIn()
{
assert(isBracketType(bracketTypeStack->back(), ARRAY_TYPE));
// make sure the bracket is broken
if (formattedLine.find_first_not_of(" \t{") != string::npos)
return;
size_t lastText = formattedLine.find_last_not_of(" \t");
if (lastText == string::npos || formattedLine[lastText] != '{')
return;
// check for extra whitespace
if (formattedLine.length() > lastText + 1
&& formattedLine.find_first_not_of(" \t", lastText + 1) == string::npos)
formattedLine.erase(lastText + 1);
if (getIndentString() == "\t")
{
appendChar('\t', false);
horstmannIndentChars = 2; // one for { and one for tab
}
else
{
int indent = getIndentLength();
formattedLine.append(indent - 1, ' ');
horstmannIndentChars = indent;
}
isInHorstmannRunIn = true;
isInLineBreak = false;
}
/**
* delete a bracketTypeStack vector object
* BracketTypeStack did not work with the DeleteContainer template
*/
void ASFormatter::deleteContainer(vector* &container)
{
if (container != NULL)
{
container->clear();
delete (container);
container = NULL;
}
}
/**
* delete a vector object
* T is the type of vector
* used for all vectors except bracketTypeStack
*/
template
void ASFormatter::deleteContainer(T &container)
{
if (container != NULL)
{
container->clear();
delete (container);
container = NULL;
}
}
/**
* initialize a BracketType vector object
* BracketType did not work with the DeleteContainer template
*/
void ASFormatter::initContainer(vector* &container, vector* value)
{
if (container != NULL)
deleteContainer(container);
container = value;
}
/**
* initialize a vector object
* T is the type of vector
* used for all vectors except bracketTypeStack
*/
template
void ASFormatter::initContainer(T &container, T value)
{
// since the ASFormatter object is never deleted,
// the existing vectors must be deleted before creating new ones
if (container != NULL)
deleteContainer(container);
container = value;
}
/**
* convert a tab to spaces.
* charNum points to the current character to convert to spaces.
* tabIncrementIn is the increment that must be added for tab indent characters
* to get the correct column for the current tab.
* replaces the tab in currentLine with the required number of spaces.
* replaces the value of currentChar.
*/
void ASFormatter::convertTabToSpaces()
{
assert(currentLine[charNum] == '\t');
// do NOT replace if in quotes
if (isInQuote || isInQuoteContinuation)
return;
size_t tabSize = getTabLength();
size_t numSpaces = tabSize - ((tabIncrementIn + charNum) % tabSize);
currentLine.replace(charNum, 1, numSpaces, ' ');
currentChar = currentLine[charNum];
}
/**
* is it ok to break this block?
*/
bool ASFormatter::isOkToBreakBlock(BracketType bracketType) const
{
// Actually, there should not be an ARRAY_TYPE bracket here.
// But this will avoid breaking a one line block when there is.
// Otherwise they will be formatted differently on consecutive runs.
if (isBracketType(bracketType, ARRAY_TYPE)
&& isBracketType(bracketType, SINGLE_LINE_TYPE))
return false;
if (!isBracketType(bracketType, SINGLE_LINE_TYPE)
|| shouldBreakOneLineBlocks
|| breakCurrentOneLineBlock)
return true;
return false;
}
/**
* check if a sharp header is a paren or nonparen header
*/
bool ASFormatter::isSharpStyleWithParen(const string* header) const
{
if (isSharpStyle() && peekNextChar() == '('
&& (header == &AS_CATCH
|| header == &AS_DELEGATE))
return true;
return false;
}
/**
* Check for a following header when a comment is reached.
* firstLine must contain the start of the comment.
* return value is a pointer to the header or NULL.
*/
const string* ASFormatter::checkForHeaderFollowingComment(const string &firstLine) const
{
assert(isInComment || isInLineComment);
assert(shouldBreakElseIfs || shouldBreakBlocks || isInSwitchStatement());
// look ahead to find the next non-comment text
bool endOnEmptyLine = (currentHeader == NULL);
if (isInSwitchStatement())
endOnEmptyLine = false;
string nextText = peekNextText(firstLine, endOnEmptyLine);
if (nextText.length() == 0 || !isCharPotentialHeader(nextText, 0))
return NULL;
return ASBeautifier::findHeader(nextText, 0, headers);
}
/**
* process preprocessor statements.
* charNum should be the index of the #.
*
* delete bracketTypeStack entries added by #if if a #else is found.
* prevents double entries in the bracketTypeStack.
*/
void ASFormatter::processPreprocessor()
{
assert(currentChar == '#');
const size_t preproc = currentLine.find_first_not_of(" \t", charNum + 1);
if (preproc == string::npos)
return;
if (currentLine.compare(preproc, 2, "if") == 0)
{
preprocBracketTypeStackSize = bracketTypeStack->size();
}
else if (currentLine.compare(preproc, 4, "else") == 0)
{
// delete stack entries added in #if
// should be replaced by #else
if (preprocBracketTypeStackSize > 0)
{
int addedPreproc = bracketTypeStack->size() - preprocBracketTypeStackSize;
for (int i = 0; i < addedPreproc; i++)
bracketTypeStack->pop_back();
}
}
}
/**
* determine if the next line starts a comment
* and a header follows the comment or comments.
*/
bool ASFormatter::commentAndHeaderFollows()
{
// called ONLY IF shouldDeleteEmptyLines and shouldBreakBlocks are TRUE.
assert(shouldDeleteEmptyLines && shouldBreakBlocks);
// is the next line a comment
if (!sourceIterator->hasMoreLines())
return false;
string nextLine_ = sourceIterator->peekNextLine();
size_t firstChar = nextLine_.find_first_not_of(" \t");
if (firstChar == string::npos
|| !(nextLine_.compare(firstChar, 2, "//") == 0
|| nextLine_.compare(firstChar, 2, "/*") == 0))
{
sourceIterator->peekReset();
return false;
}
// find the next non-comment text, and reset
string nextText = peekNextText(nextLine_, false, true);
if (nextText.length() == 0 || !isCharPotentialHeader(nextText, 0))
return false;
const string* newHeader = ASBeautifier::findHeader(nextText, 0, headers);
if (newHeader == NULL)
return false;
// if a closing header, reset break unless break is requested
if (isClosingHeader(newHeader) && !shouldBreakClosingHeaderBlocks)
{
isAppendPostBlockEmptyLineRequested = false;
return false;
}
return true;
}
/**
* determine if a bracket should be attached or broken
* uses brackets in the bracketTypeStack
* the last bracket in the bracketTypeStack is the one being formatted
* returns true if the bracket should be broken
*/
bool ASFormatter::isCurrentBracketBroken() const
{
assert(bracketTypeStack->size() > 1);
bool breakBracket = false;
size_t stackEnd = bracketTypeStack->size() - 1;
// check bracket modifiers
if (shouldAttachExternC
&& isBracketType((*bracketTypeStack)[stackEnd], EXTERN_TYPE))
{
return false;
}
if (shouldAttachNamespace
&& isBracketType((*bracketTypeStack)[stackEnd], NAMESPACE_TYPE))
{
return false;
}
else if (shouldAttachClass
&& (isBracketType((*bracketTypeStack)[stackEnd], CLASS_TYPE)
|| isBracketType((*bracketTypeStack)[stackEnd], INTERFACE_TYPE)))
{
return false;
}
else if (shouldAttachInline
&& isCStyle() // for C++ only
&& bracketFormatMode != RUN_IN_MODE
&& isBracketType((*bracketTypeStack)[stackEnd], COMMAND_TYPE))
{
size_t i;
for (i = 1; i < bracketTypeStack->size(); i++)
if (isBracketType((*bracketTypeStack)[i], CLASS_TYPE)
|| isBracketType((*bracketTypeStack)[i], STRUCT_TYPE))
return false;
}
// check brackets
if (isBracketType((*bracketTypeStack)[stackEnd], EXTERN_TYPE))
{
if (currentLineBeginsWithBracket
|| bracketFormatMode == RUN_IN_MODE)
breakBracket = true;
}
else if (bracketFormatMode == NONE_MODE)
{
if (currentLineBeginsWithBracket
&& (int)currentLineFirstBracketNum == charNum)
breakBracket = true;
}
else if (bracketFormatMode == BREAK_MODE || bracketFormatMode == RUN_IN_MODE)
{
breakBracket = true;
}
else if (bracketFormatMode == LINUX_MODE || bracketFormatMode == STROUSTRUP_MODE)
{
// break a namespace, class, or interface if Linux
if (isBracketType((*bracketTypeStack)[stackEnd], NAMESPACE_TYPE)
|| isBracketType((*bracketTypeStack)[stackEnd], CLASS_TYPE)
|| isBracketType((*bracketTypeStack)[stackEnd], INTERFACE_TYPE))
{
if (bracketFormatMode == LINUX_MODE)
breakBracket = true;
}
// break the first bracket if a function
else if (isBracketType((*bracketTypeStack)[stackEnd], COMMAND_TYPE))
{
if (stackEnd == 1)
{
breakBracket = true;
}
else if (stackEnd > 1)
{
// break the first bracket after these if a function
if (isBracketType((*bracketTypeStack)[stackEnd - 1], NAMESPACE_TYPE)
|| isBracketType((*bracketTypeStack)[stackEnd - 1], CLASS_TYPE)
|| isBracketType((*bracketTypeStack)[stackEnd - 1], ARRAY_TYPE)
|| isBracketType((*bracketTypeStack)[stackEnd - 1], STRUCT_TYPE)
|| isBracketType((*bracketTypeStack)[stackEnd - 1], EXTERN_TYPE))
{
breakBracket = true;
}
}
}
}
return breakBracket;
}
/**
* format comment body
* the calling function should have a continue statement after calling this method
*/
void ASFormatter::formatCommentBody()
{
assert(isInComment);
// append the comment
while (charNum < (int) currentLine.length())
{
currentChar = currentLine[charNum];
if (currentLine.compare(charNum, 2, "*/") == 0)
{
formatCommentCloser();
break;
}
if (currentChar == '\t' && shouldConvertTabs)
convertTabToSpaces();
appendCurrentChar();
++charNum;
}
if (shouldStripCommentPrefix)
stripCommentPrefix();
}
/**
* format a comment opener
* the comment opener will be appended to the current formattedLine or a new formattedLine as necessary
* the calling function should have a continue statement after calling this method
*/
void ASFormatter::formatCommentOpener()
{
assert(isSequenceReached("/*"));
isInComment = isInCommentStartLine = true;
isImmediatelyPostLineComment = false;
if (previousNonWSChar == '}')
resetEndOfStatement();
// Check for a following header.
// For speed do not check multiple comment lines more than once.
// For speed do not check shouldBreakBlocks if previous line is empty, a comment, or a '{'.
const string* followingHeader = NULL;
if ((doesLineStartComment
&& !isImmediatelyPostCommentOnly
&& isBracketType(bracketTypeStack->back(), COMMAND_TYPE))
&& (shouldBreakElseIfs
|| isInSwitchStatement()
|| (shouldBreakBlocks
&& !isImmediatelyPostEmptyLine
&& previousCommandChar != '{')))
followingHeader = checkForHeaderFollowingComment(currentLine.substr(charNum));
if (spacePadNum != 0 && !isInLineBreak)
adjustComments();
formattedLineCommentNum = formattedLine.length();
// must be done BEFORE appendSequence
if (previousCommandChar == '{'
&& !isImmediatelyPostComment
&& !isImmediatelyPostLineComment)
{
if (bracketFormatMode == NONE_MODE)
{
// should a run-in statement be attached?
if (currentLineBeginsWithBracket)
formatRunIn();
}
else if (bracketFormatMode == ATTACH_MODE)
{
// if the bracket was not attached?
if (formattedLine.length() > 0 && formattedLine[0] == '{'
&& !isBracketType(bracketTypeStack->back(), SINGLE_LINE_TYPE))
isInLineBreak = true;
}
else if (bracketFormatMode == RUN_IN_MODE)
{
// should a run-in statement be attached?
if (formattedLine.length() > 0 && formattedLine[0] == '{')
formatRunIn();
}
}
else if (!doesLineStartComment)
noTrimCommentContinuation = true;
// ASBeautifier needs to know the following statements
if (shouldBreakElseIfs && followingHeader == &AS_ELSE)
elseHeaderFollowsComments = true;
if (followingHeader == &AS_CASE || followingHeader == &AS_DEFAULT)
caseHeaderFollowsComments = true;
// appendSequence will write the previous line
appendSequence(AS_OPEN_COMMENT);
goForward(1);
// must be done AFTER appendSequence
// Break before the comment if a header follows the line comment.
// But not break if previous line is empty, a comment, or a '{'.
if (shouldBreakBlocks
&& followingHeader != NULL
&& !isImmediatelyPostEmptyLine
&& previousCommandChar != '{')
{
if (isClosingHeader(followingHeader))
{
if (!shouldBreakClosingHeaderBlocks)
isPrependPostBlockEmptyLineRequested = false;
}
// if an opening header, break before the comment
else
isPrependPostBlockEmptyLineRequested = true;
}
if (previousCommandChar == '}')
currentHeader = NULL;
}
/**
* format a comment closer
* the comment closer will be appended to the current formattedLine
*/
void ASFormatter::formatCommentCloser()
{
isInComment = false;
noTrimCommentContinuation = false;
isImmediatelyPostComment = true;
appendSequence(AS_CLOSE_COMMENT);
goForward(1);
if (doesLineStartComment
&& (currentLine.find_first_not_of(" \t", charNum + 1) == string::npos))
lineEndsInCommentOnly = true;
if (peekNextChar() == '}'
&& previousCommandChar != ';'
&& !isBracketType(bracketTypeStack->back(), ARRAY_TYPE)
&& !isInPreprocessor
&& isOkToBreakBlock(bracketTypeStack->back()))
{
isInLineBreak = true;
shouldBreakLineAtNextChar = true;
}
}
/**
* format a line comment body
* the calling function should have a continue statement after calling this method
*/
void ASFormatter::formatLineCommentBody()
{
assert(isInLineComment);
// append the comment
while (charNum < (int) currentLine.length())
// && !isLineReady // commented out in release 2.04, unnecessary
{
currentChar = currentLine[charNum];
if (currentChar == '\t' && shouldConvertTabs)
convertTabToSpaces();
appendCurrentChar();
++charNum;
}
// explicitly break a line when a line comment's end is found.
if (charNum == (int) currentLine.length())
{
isInLineBreak = true;
isInLineComment = false;
isImmediatelyPostLineComment = true;
currentChar = 0; //make sure it is a neutral char.
}
}
/**
* format a line comment opener
* the line comment opener will be appended to the current formattedLine or a new formattedLine as necessary
* the calling function should have a continue statement after calling this method
*/
void ASFormatter::formatLineCommentOpener()
{
assert(isSequenceReached("//"));
if ((int)currentLine.length() > charNum + 2
&& currentLine[charNum + 2] == '\xf2') // check for windows line marker
isAppendPostBlockEmptyLineRequested = false;
isInLineComment = true;
isCharImmediatelyPostComment = false;
if (previousNonWSChar == '}')
resetEndOfStatement();
// Check for a following header.
// For speed do not check multiple comment lines more than once.
// For speed do not check shouldBreakBlocks if previous line is empty, a comment, or a '{'.
const string* followingHeader = NULL;
if ((lineIsLineCommentOnly
&& !isImmediatelyPostCommentOnly
&& isBracketType(bracketTypeStack->back(), COMMAND_TYPE))
&& (shouldBreakElseIfs
|| isInSwitchStatement()
|| (shouldBreakBlocks
&& !isImmediatelyPostEmptyLine
&& previousCommandChar != '{')))
followingHeader = checkForHeaderFollowingComment(currentLine.substr(charNum));
// do not indent if in column 1 or 2
if (!shouldIndentCol1Comments && !lineCommentNoIndent)
{
if (charNum == 0)
lineCommentNoIndent = true;
else if (charNum == 1 && currentLine[0] == ' ')
lineCommentNoIndent = true;
}
// move comment if spaces were added or deleted
if (lineCommentNoIndent == false && spacePadNum != 0 && !isInLineBreak)
adjustComments();
formattedLineCommentNum = formattedLine.length();
// must be done BEFORE appendSequence
// check for run-in statement
if (previousCommandChar == '{'
&& !isImmediatelyPostComment
&& !isImmediatelyPostLineComment)
{
if (bracketFormatMode == NONE_MODE)
{
if (currentLineBeginsWithBracket)
formatRunIn();
}
else if (bracketFormatMode == RUN_IN_MODE)
{
if (!lineCommentNoIndent)
formatRunIn();
else
isInLineBreak = true;
}
else if (bracketFormatMode == BREAK_MODE)
{
if (formattedLine.length() > 0 && formattedLine[0] == '{')
isInLineBreak = true;
}
else
{
if (currentLineBeginsWithBracket)
isInLineBreak = true;
}
}
// ASBeautifier needs to know the following statements
if (shouldBreakElseIfs && followingHeader == &AS_ELSE)
elseHeaderFollowsComments = true;
if (followingHeader == &AS_CASE || followingHeader == &AS_DEFAULT)
caseHeaderFollowsComments = true;
// appendSequence will write the previous line
appendSequence(AS_OPEN_LINE_COMMENT);
goForward(1);
// must be done AFTER appendSequence
// Break before the comment if a header follows the line comment.
// But do not break if previous line is empty, a comment, or a '{'.
if (shouldBreakBlocks
&& followingHeader != NULL
&& !isImmediatelyPostEmptyLine
&& previousCommandChar != '{')
{
if (isClosingHeader(followingHeader))
{
if (!shouldBreakClosingHeaderBlocks)
isPrependPostBlockEmptyLineRequested = false;
}
// if an opening header, break before the comment
else
isPrependPostBlockEmptyLineRequested = true;
}
if (previousCommandChar == '}')
currentHeader = NULL;
// if tabbed input don't convert the immediately following tabs to spaces
if (getIndentString() == "\t" && lineCommentNoIndent)
{
while (charNum + 1 < (int) currentLine.length()
&& currentLine[charNum + 1] == '\t')
{
currentChar = currentLine[++charNum];
appendCurrentChar();
}
}
// explicitely break a line when a line comment's end is found.
if (charNum + 1 == (int) currentLine.length())
{
isInLineBreak = true;
isInLineComment = false;
isImmediatelyPostLineComment = true;
currentChar = 0; //make sure it is a neutral char.
}
}
/**
* format quote body
* the calling function should have a continue statement after calling this method
*/
void ASFormatter::formatQuoteBody()
{
assert(isInQuote);
if (isSpecialChar)
{
isSpecialChar = false;
}
else if (currentChar == '\\' && !isInVerbatimQuote)
{
if (peekNextChar() == ' ') // is this '\' at end of line
haveLineContinuationChar = true;
else
isSpecialChar = true;
}
else if (isInVerbatimQuote && currentChar == '"')
{
if (peekNextChar() == '"') // check consecutive quotes
{
appendSequence("\"\"");
goForward(1);
return;
}
else
{
isInQuote = false;
isInVerbatimQuote = false;
}
}
else if (quoteChar == currentChar)
{
isInQuote = false;
}
appendCurrentChar();
// append the text to the ending quoteChar or an escape sequence
// tabs in quotes are NOT changed by convert-tabs
if (isInQuote && currentChar != '\\')
{
while (charNum + 1 < (int) currentLine.length()
&& currentLine[charNum + 1] != quoteChar
&& currentLine[charNum + 1] != '\\')
{
currentChar = currentLine[++charNum];
appendCurrentChar();
}
}
}
/**
* format a quote opener
* the quote opener will be appended to the current formattedLine or a new formattedLine as necessary
* the calling function should have a continue statement after calling this method
*/
void ASFormatter::formatQuoteOpener()
{
assert(currentChar == '"' || currentChar == '\'');
isInQuote = true;
quoteChar = currentChar;
if (isSharpStyle() && previousChar == '@')
isInVerbatimQuote = true;
// a quote following a bracket is an array
if (previousCommandChar == '{'
&& !isImmediatelyPostComment
&& !isImmediatelyPostLineComment
&& isNonInStatementArray
&& !isBracketType(bracketTypeStack->back(), SINGLE_LINE_TYPE)
&& !isWhiteSpace(peekNextChar()))
{
if (bracketFormatMode == NONE_MODE)
{
if (currentLineBeginsWithBracket)
formatRunIn();
}
else if (bracketFormatMode == RUN_IN_MODE)
{
formatRunIn();
}
else if (bracketFormatMode == BREAK_MODE)
{
if (formattedLine.length() > 0 && formattedLine[0] == '{')
isInLineBreak = true;
}
else
{
if (currentLineBeginsWithBracket)
isInLineBreak = true;
}
}
previousCommandChar = ' ';
appendCurrentChar();
}
/**
* get the next line comment adjustment that results from breaking a closing bracket.
* the bracket must be on the same line as the closing header.
* i.e "} else" changed to "} \n else".
*/
int ASFormatter::getNextLineCommentAdjustment()
{
assert(foundClosingHeader && previousNonWSChar == '}');
if (charNum < 1) // "else" is in column 1
return 0;
size_t lastBracket = currentLine.rfind('}', charNum - 1);
if (lastBracket != string::npos)
return (lastBracket - charNum); // return a negative number
return 0;
}
// for console build only
LineEndFormat ASFormatter::getLineEndFormat() const
{
return lineEnd;
}
/**
* get the current line comment adjustment that results from attaching
* a closing header to a closing bracket.
* the bracket must be on the line previous to the closing header.
* the adjustment is 2 chars, one for the bracket and one for the space.
* i.e "} \n else" changed to "} else".
*/
int ASFormatter::getCurrentLineCommentAdjustment()
{
assert(foundClosingHeader && previousNonWSChar == '}');
if (charNum < 1)
return 2;
size_t lastBracket = currentLine.rfind('}', charNum - 1);
if (lastBracket == string::npos)
return 2;
return 0;
}
/**
* get the previous word on a line
* the argument 'currPos' must point to the current position.
*
* @return is the previous word or an empty string if none found.
*/
string ASFormatter::getPreviousWord(const string &line, int currPos) const
{
// get the last legal word (may be a number)
if (currPos == 0)
return string();
size_t end = line.find_last_not_of(" \t", currPos - 1);
if (end == string::npos || !isLegalNameChar(line[end]))
return string();
int start; // start of the previous word
for (start = end; start > -1; start--)
{
if (!isLegalNameChar(line[start]) || line[start] == '.')
break;
}
start++;
return (line.substr(start, end - start + 1));
}
/**
* check if a line break is needed when a closing bracket
* is followed by a closing header.
* the break depends on the bracketFormatMode and other factors.
*/
void ASFormatter::isLineBreakBeforeClosingHeader()
{
assert(foundClosingHeader && previousNonWSChar == '}');
if (bracketFormatMode == BREAK_MODE
|| bracketFormatMode == RUN_IN_MODE
|| shouldAttachClosingBracket)
{
isInLineBreak = true;
}
else if (bracketFormatMode == NONE_MODE)
{
if (shouldBreakClosingHeaderBrackets
|| getBracketIndent() || getBlockIndent())
{
isInLineBreak = true;
}
else
{
appendSpacePad();
// is closing bracket broken?
size_t i = currentLine.find_first_not_of(" \t");
if (i != string::npos && currentLine[i] == '}')
isInLineBreak = false;
if (shouldBreakBlocks)
isAppendPostBlockEmptyLineRequested = false;
}
}
// bracketFormatMode == ATTACH_MODE, LINUX_MODE, STROUSTRUP_MODE
else
{
if (shouldBreakClosingHeaderBrackets
|| getBracketIndent() || getBlockIndent())
{
isInLineBreak = true;
}
else
{
// if a blank line does not precede this
// or last line is not a one line block, attach header
bool previousLineIsEmpty = isEmptyLine(formattedLine);
int previousLineIsOneLineBlock = 0;
size_t firstBracket = findNextChar(formattedLine, '{');
if (firstBracket != string::npos)
previousLineIsOneLineBlock = isOneLineBlockReached(formattedLine, firstBracket);
if (!previousLineIsEmpty
&& previousLineIsOneLineBlock == 0)
{
isInLineBreak = false;
appendSpacePad();
spacePadNum = 0; // don't count as comment padding
}
if (shouldBreakBlocks)
isAppendPostBlockEmptyLineRequested = false;
}
}
}
/**
* Add brackets to a single line statement following a header.
* Brackets are not added if the proper conditions are not met.
* Brackets are added to the currentLine.
*/
bool ASFormatter::addBracketsToStatement()
{
assert(isImmediatelyPostHeader);
if (currentHeader != &AS_IF
&& currentHeader != &AS_ELSE
&& currentHeader != &AS_FOR
&& currentHeader != &AS_WHILE
&& currentHeader != &AS_DO
&& currentHeader != &AS_FOREACH)
return false;
if (currentHeader == &AS_WHILE && foundClosingHeader) // do-while
return false;
// do not bracket an empty statement
if (currentChar == ';')
return false;
// do not add if a header follows
if (isCharPotentialHeader(currentLine, charNum))
if (findHeader(headers) != NULL)
return false;
// find the next semi-colon
size_t nextSemiColon = charNum;
if (currentChar != ';')
nextSemiColon = findNextChar(currentLine, ';', charNum + 1);
if (nextSemiColon == string::npos)
return false;
// add closing bracket before changing the line length
if (nextSemiColon == currentLine.length() - 1)
currentLine.append(" }");
else
currentLine.insert(nextSemiColon + 1, " }");
// add opening bracket
currentLine.insert(charNum, "{ ");
assert(computeChecksumIn("{}"));
currentChar = '{';
// remove extra spaces
if (!shouldAddOneLineBrackets)
{
size_t lastText = formattedLine.find_last_not_of(" \t");
if ((formattedLine.length() - 1) - lastText > 1)
formattedLine.erase(lastText + 1);
}
return true;
}
/**
* Remove brackets from a single line statement following a header.
* Brackets are not removed if the proper conditions are not met.
* The first bracket is replaced by a space.
*/
bool ASFormatter::removeBracketsFromStatement()
{
assert(isImmediatelyPostHeader);
assert(currentChar == '{');
if (currentHeader != &AS_IF
&& currentHeader != &AS_ELSE
&& currentHeader != &AS_FOR
&& currentHeader != &AS_WHILE
&& currentHeader != &AS_FOREACH)
return false;
if (currentHeader == &AS_WHILE && foundClosingHeader) // do-while
return false;
bool isFirstLine = true;
bool needReset = false;
string nextLine_;
// leave nextLine_ empty if end of line comment follows
if (!isBeforeAnyLineEndComment(charNum) || currentLineBeginsWithBracket)
nextLine_ = currentLine.substr(charNum + 1);
size_t nextChar = 0;
// find the first non-blank text
while (sourceIterator->hasMoreLines() || isFirstLine)
{
if (isFirstLine)
isFirstLine = false;
else
{
nextLine_ = sourceIterator->peekNextLine();
nextChar = 0;
needReset = true;
}
nextChar = nextLine_.find_first_not_of(" \t", nextChar);
if (nextChar != string::npos)
break;
}
// don't remove if comments or a header follow the bracket
if ((nextLine_.compare(nextChar, 2, "/*") == 0)
|| (nextLine_.compare(nextChar, 2, "//") == 0)
|| (isCharPotentialHeader(nextLine_, nextChar)
&& ASBeautifier::findHeader(nextLine_, nextChar, headers) != NULL))
{
if (needReset)
sourceIterator->peekReset();
return false;
}
// find the next semi-colon
size_t nextSemiColon = nextChar;
if (nextLine_[nextChar] != ';')
nextSemiColon = findNextChar(nextLine_, ';', nextChar + 1);
if (nextSemiColon == string::npos)
{
if (needReset)
sourceIterator->peekReset();
return false;
}
// find the closing bracket
isFirstLine = true;
nextChar = nextSemiColon + 1;
while (sourceIterator->hasMoreLines() || isFirstLine)
{
if (isFirstLine)
isFirstLine = false;
else
{
nextLine_ = sourceIterator->peekNextLine();
nextChar = 0;
needReset = true;
}
nextChar = nextLine_.find_first_not_of(" \t", nextChar);
if (nextChar != string::npos)
break;
}
if (nextLine_.length() == 0 || nextLine_[nextChar] != '}')
{
if (needReset)
sourceIterator->peekReset();
return false;
}
// remove opening bracket
currentLine[charNum] = currentChar = ' ';
assert(adjustChecksumIn(-'{'));
if (needReset)
sourceIterator->peekReset();
return true;
}
/**
* Find the next character that is not in quotes or a comment.
*
* @param line the line to be searched.
* @param searchChar the char to find.
* @param searchStart the start position on the line (default is 0).
* @return the position on the line or string::npos if not found.
*/
size_t ASFormatter::findNextChar(string &line, char searchChar, int searchStart /*0*/)
{
// find the next searchChar
size_t i;
for (i = searchStart; i < line.length(); i++)
{
if (line.compare(i, 2, "//") == 0)
return string::npos;
if (line.compare(i, 2, "/*") == 0)
{
size_t endComment = line.find("*/", i + 2);
if (endComment == string::npos)
return string::npos;
i = endComment + 2;
if (i >= line.length())
return string::npos;
}
if (line[i] == '\'' || line[i] == '\"')
{
char quote = line[i];
while (i < line.length())
{
size_t endQuote = line.find(quote, i + 1);
if (endQuote == string::npos)
return string::npos;
i = endQuote;
if (line[endQuote - 1] != '\\') // check for '\"'
break;
if (line[endQuote - 2] == '\\') // check for '\\'
break;
}
}
if (line[i] == searchChar)
break;
// for now don't process C# 'delegate' brackets
// do this last in case the search char is a '{'
if (line[i] == '{')
return string::npos;
}
if (i >= line.length()) // didn't find searchChar
return string::npos;
return i;
}
/**
* Look ahead in the file to see if a struct has access modifiers.
*
* @param line a reference to the line to indent.
* @param index the current line index.
* @return true if the struct has access modifiers.
*/
bool ASFormatter::isStructAccessModified(string &firstLine, size_t index) const
{
assert(firstLine[index] == '{');
assert(isCStyle());
bool isFirstLine = true;
bool needReset = false;
size_t bracketCount = 1;
string nextLine_ = firstLine.substr(index + 1);
// find the first non-blank text, bypassing all comments and quotes.
bool isInComment_ = false;
bool isInQuote_ = false;
char quoteChar_ = ' ';
while (sourceIterator->hasMoreLines() || isFirstLine)
{
if (isFirstLine)
isFirstLine = false;
else
{
nextLine_ = sourceIterator->peekNextLine();
needReset = true;
}
// parse the line
for (size_t i = 0; i < nextLine_.length(); i++)
{
if (isWhiteSpace(nextLine_[i]))
continue;
if (nextLine_.compare(i, 2, "/*") == 0)
isInComment_ = true;
if (isInComment_)
{
if (nextLine_.compare(i, 2, "*/") == 0)
{
isInComment_ = false;
++i;
}
continue;
}
if (nextLine_[i] == '\\')
{
++i;
continue;
}
if (isInQuote_)
{
if (nextLine_[i] == quoteChar_)
isInQuote_ = false;
continue;
}
if (nextLine_[i] == '"' || nextLine_[i] == '\'')
{
isInQuote_ = true;
quoteChar_ = nextLine_[i];
continue;
}
if (nextLine_.compare(i, 2, "//") == 0)
{
i = nextLine_.length();
continue;
}
// handle brackets
if (nextLine_[i] == '{')
++bracketCount;
if (nextLine_[i] == '}')
--bracketCount;
if (bracketCount == 0)
{
if (needReset)
sourceIterator->peekReset();
return false;
}
// check for access modifiers
if (isCharPotentialHeader(nextLine_, i))
{
if (findKeyword(nextLine_, i, AS_PUBLIC)
|| findKeyword(nextLine_, i, AS_PRIVATE)
|| findKeyword(nextLine_, i, AS_PROTECTED))
{
if (needReset)
sourceIterator->peekReset();
return true;
}
string name = getCurrentWord(nextLine_, i);
i += name.length() - 1;
}
} // end of for loop
} // end of while loop
if (needReset)
sourceIterator->peekReset();
return false;
}
/**
* Check to see if this is an EXEC SQL statement.
*
* @param line a reference to the line to indent.
* @param index the current line index.
* @return true if the statement is EXEC SQL.
*/
bool ASFormatter::isExecSQL(string &line, size_t index) const
{
if (line[index] != 'e' && line[index] != 'E') // quick check to reject most
return false;
string word;
if (isCharPotentialHeader(line, index))
word = getCurrentWord(line, index);
for (size_t i = 0; i < word.length(); i++)
word[i] = (char) toupper(word[i]);
if (word != "EXEC")
return false;
size_t index2 = index + word.length();
index2 = line.find_first_not_of(" \t", index2);
if (index2 == string::npos)
return false;
word.erase();
if (isCharPotentialHeader(line, index2))
word = getCurrentWord(line, index2);
for (size_t i = 0; i < word.length(); i++)
word[i] = (char) toupper(word[i]);
if (word != "SQL")
return false;
return true;
}
/**
* The continuation lines must be adjusted so the leading spaces
* is equivalent to the text on the opening line.
*
* Updates currentLine and charNum.
*/
void ASFormatter::trimContinuationLine()
{
size_t len = currentLine.length();
size_t tabSize = getTabLength();
charNum = 0;
if (leadingSpaces > 0 && len > 0)
{
size_t i;
size_t continuationIncrementIn = 0;
for (i = 0; (i < len) && (i + continuationIncrementIn < leadingSpaces); i++)
{
if (!isWhiteSpace(currentLine[i])) // don't delete any text
{
if (i < continuationIncrementIn)
leadingSpaces = i + tabIncrementIn;
continuationIncrementIn = tabIncrementIn;
break;
}
if (currentLine[i] == '\t')
continuationIncrementIn += tabSize - 1 - ((continuationIncrementIn + i) % tabSize);
}
if ((int) continuationIncrementIn == tabIncrementIn)
charNum = i;
else
{
// build a new line with the equivalent leading chars
string newLine;
int leadingChars = 0;
if ((int) leadingSpaces > tabIncrementIn)
leadingChars = leadingSpaces - tabIncrementIn;
newLine.append(leadingChars, ' ');
newLine.append(currentLine, i, len - i);
currentLine = newLine;
charNum = leadingChars;
if (currentLine.length() == 0)
currentLine = string(" "); // a null is inserted if this is not done
}
if (i >= len)
charNum = 0;
}
return;
}
/**
* Determine if a header is a closing header
*
* @return true if the header is a closing header.
*/
bool ASFormatter::isClosingHeader(const string* header) const
{
return (header == &AS_ELSE
|| header == &AS_CATCH
|| header == &AS_FINALLY);
}
/**
* Determine if a * following a closing paren is immediately.
* after a cast. If so it is a deference and not a multiply.
* e.g. "(int*) *ptr" is a deference.
*/
bool ASFormatter::isImmediatelyPostCast() const
{
assert(previousNonWSChar == ')' && currentChar == '*');
// find preceding closing paren on currentLine or readyFormattedLine
string line; // currentLine or readyFormattedLine
size_t paren = currentLine.rfind(")", charNum);
if (paren != string::npos)
line = currentLine;
// if not on currentLine it must be on the previous line
else
{
line = readyFormattedLine;
paren = line.rfind(")");
if (paren == string::npos)
return false;
}
if (paren == 0)
return false;
// find character preceding the closing paren
size_t lastChar = line.find_last_not_of(" \t", paren - 1);
if (lastChar == string::npos)
return false;
// check for pointer cast
if (line[lastChar] == '*')
return true;
return false;
}
/**
* Determine if a < is a template definition or instantiation.
* Sets the class variables isInTemplate and templateDepth.
*/
void ASFormatter::checkIfTemplateOpener()
{
assert(!isInTemplate && currentChar == '<');
// find first char after the '<' operators
size_t firstChar = currentLine.find_first_not_of("< \t", charNum);
if (firstChar == string::npos
|| currentLine[firstChar] == '=')
{
// this is not a template -> leave...
isInTemplate = false;
return;
}
bool isFirstLine = true;
bool needReset = false;
int parenDepth_ = 0;
int maxTemplateDepth = 0;
templateDepth = 0;
string nextLine_ = currentLine.substr(charNum);
// find the angle brackets, bypassing all comments and quotes.
bool isInComment_ = false;
bool isInQuote_ = false;
char quoteChar_ = ' ';
while (sourceIterator->hasMoreLines() || isFirstLine)
{
if (isFirstLine)
isFirstLine = false;
else
{
nextLine_ = sourceIterator->peekNextLine();
needReset = true;
}
// parse the line
for (size_t i = 0; i < nextLine_.length(); i++)
{
char currentChar_ = nextLine_[i];
if (isWhiteSpace(currentChar_))
continue;
if (nextLine_.compare(i, 2, "/*") == 0)
isInComment_ = true;
if (isInComment_)
{
if (nextLine_.compare(i, 2, "*/") == 0)
{
isInComment_ = false;
++i;
}
continue;
}
if (currentChar_ == '\\')
{
++i;
continue;
}
if (isInQuote_)
{
if (currentChar_ == quoteChar_)
isInQuote_ = false;
continue;
}
if (currentChar_ == '"' || currentChar_ == '\'')
{
isInQuote_ = true;
quoteChar_ = currentChar_;
continue;
}
if (nextLine_.compare(i, 2, "//") == 0)
{
i = nextLine_.length();
continue;
}
// not in a comment or quote
if (currentChar_ == '<')
{
++templateDepth;
++maxTemplateDepth;
continue;
}
else if (currentChar_ == '>')
{
--templateDepth;
if (templateDepth == 0)
{
if (parenDepth_ == 0)
{
// this is a template!
isInTemplate = true;
templateDepth = maxTemplateDepth;
}
goto exitFromSearch;
}
continue;
}
else if (currentChar_ == '(' || currentChar_ == ')')
{
if (currentChar_ == '(')
++parenDepth_;
else
--parenDepth_;
if (parenDepth_ >= 0)
continue;
// this is not a template -> leave...
isInTemplate = false;
goto exitFromSearch;
}
else if (nextLine_.compare(i, 2, AS_AND) == 0
|| nextLine_.compare(i, 2, AS_OR) == 0)
{
// this is not a template -> leave...
isInTemplate = false;
goto exitFromSearch;
}
else if (currentChar_ == ',' // comma, e.g. A
|| currentChar_ == '&' // reference, e.g. A
|| currentChar_ == '*' // pointer, e.g. A
|| currentChar_ == '^' // C++/CLI managed pointer, e.g. A
|| currentChar_ == ':' // ::, e.g. std::string
|| currentChar_ == '=' // assign e.g. default parameter
|| currentChar_ == '[' // [] e.g. string[]
|| currentChar_ == ']' // [] e.g. string[]
|| currentChar_ == '(' // (...) e.g. function definition
|| currentChar_ == ')' // (...) e.g. function definition
|| (isJavaStyle() && currentChar_ == '?') // Java wildcard
)
{
continue;
}
else if (!isLegalNameChar(currentChar_))
{
// this is not a template -> leave...
isInTemplate = false;
goto exitFromSearch;
}
string name = getCurrentWord(nextLine_, i);
i += name.length() - 1;
} // end of for loop
} // end of while loop
// goto needed to exit from two loops
exitFromSearch:
if (needReset)
sourceIterator->peekReset();
}
void ASFormatter::updateFormattedLineSplitPoints(char appendedChar)
{
assert(maxCodeLength != string::npos);
assert(formattedLine.length() > 0);
if (!isOkToSplitFormattedLine())
return;
char nextChar = peekNextChar();
// don't split before an end of line comment
if (nextChar == '/')
return;
// don't split before or after a bracket
if (appendedChar == '{' || appendedChar == '}'
|| previousNonWSChar == '{' || previousNonWSChar == '}'
|| nextChar == '{' || nextChar == '}'
|| currentChar == '{' || currentChar == '}') // currentChar tests for an appended bracket
return;
// don't split before or after a block paren
if (appendedChar == '[' || appendedChar == ']'
|| previousNonWSChar == '['
|| nextChar == '[' || nextChar == ']')
return;
if (isWhiteSpace(appendedChar))
{
if (nextChar != ')' // space before a closing paren
&& nextChar != '(' // space before an opening paren
&& nextChar != '/' // space before a comment
&& nextChar != ':' // space before a colon
&& currentChar != ')' // appended space before and after a closing paren
&& currentChar != '(' // appended space before and after a opening paren
&& previousNonWSChar != '(' // decided at the '('
// don't break before a pointer or reference aligned to type
&& !(nextChar == '*'
&& !isCharPotentialOperator(previousNonWSChar)
&& pointerAlignment == PTR_ALIGN_TYPE)
&& !(nextChar == '&'
&& !isCharPotentialOperator(previousNonWSChar)
&& (referenceAlignment == REF_ALIGN_TYPE
|| (referenceAlignment == REF_SAME_AS_PTR && pointerAlignment == PTR_ALIGN_TYPE)))
)
{
if (formattedLine.length() - 1 <= maxCodeLength)
maxWhiteSpace = formattedLine.length() - 1;
else
maxWhiteSpacePending = formattedLine.length() - 1;
}
}
// unpadded closing parens may split after the paren (counts as whitespace)
else if (appendedChar == ')')
{
if (nextChar != ')'
&& nextChar != ' '
&& nextChar != ';'
&& nextChar != ','
&& nextChar != '.'
&& !(nextChar == '-' && pointerSymbolFollows())) // check for ->
{
if (formattedLine.length() <= maxCodeLength)
maxWhiteSpace = formattedLine.length();
else
maxWhiteSpacePending = formattedLine.length();
}
}
// unpadded commas may split after the comma
else if (appendedChar == ',')
{
if (formattedLine.length() <= maxCodeLength)
maxComma = formattedLine.length();
else
maxCommaPending = formattedLine.length();
}
else if (appendedChar == '(')
{
if (nextChar != ')' && nextChar != '(' && nextChar != '"' && nextChar != '\'')
{
// if follows an operator break before
size_t parenNum;
if (isCharPotentialOperator(previousNonWSChar))
parenNum = formattedLine.length() - 1 ;
else
parenNum = formattedLine.length();
if (formattedLine.length() <= maxCodeLength)
maxParen = parenNum;
else
maxParenPending = parenNum;
}
}
else if (appendedChar == ';')
{
if (nextChar != ' ' && nextChar != '}' && nextChar != '/') // check for following comment
{
if (formattedLine.length() <= maxCodeLength)
maxSemi = formattedLine.length();
else
maxSemiPending = formattedLine.length();
}
}
}
void ASFormatter::updateFormattedLineSplitPointsOperator(const string &sequence)
{
assert(maxCodeLength != string::npos);
assert(formattedLine.length() > 0);
if (!isOkToSplitFormattedLine())
return;
char nextChar = peekNextChar();
// don't split before an end of line comment
if (nextChar == '/')
return;
// check for logical conditional
if (sequence == "||" || sequence == "&&" || sequence == "or" || sequence == "and")
{
if (shouldBreakLineAfterLogical)
{
if (formattedLine.length() <= maxCodeLength)
maxAndOr = formattedLine.length();
else
maxAndOrPending = formattedLine.length();
}
else
{
// adjust for leading space in the sequence
size_t sequenceLength = sequence.length();
if (formattedLine.length() > sequenceLength
&& isWhiteSpace(formattedLine[formattedLine.length() - sequenceLength - 1]))
sequenceLength++;
if (formattedLine.length() - sequenceLength <= maxCodeLength)
maxAndOr = formattedLine.length() - sequenceLength;
else
maxAndOrPending = formattedLine.length() - sequenceLength;
}
}
// comparison operators will split after the operator (counts as whitespace)
else if (sequence == "==" || sequence == "!=" || sequence == ">=" || sequence == "<=")
{
if (formattedLine.length() <= maxCodeLength)
maxWhiteSpace = formattedLine.length();
else
maxWhiteSpacePending = formattedLine.length();
}
// unpadded operators that will split BEFORE the operator (counts as whitespace)
else if (sequence == "+" || sequence == "-" || sequence == "?")
{
if (charNum > 0
&& (isLegalNameChar(currentLine[charNum - 1])
|| currentLine[charNum - 1] == ')'
|| currentLine[charNum - 1] == ']'
|| currentLine[charNum - 1] == '\"'))
{
if (formattedLine.length() - 1 <= maxCodeLength)
maxWhiteSpace = formattedLine.length() - 1;
else
maxWhiteSpacePending = formattedLine.length() - 1;
}
}
// unpadded operators that will USUALLY split AFTER the operator (counts as whitespace)
else if (sequence == "=" || sequence == ":")
{
// split BEFORE if the line is too long
// do NOT use <= here, must allow for a bracket attached to an array
size_t splitPoint = 0;
if (formattedLine.length() < maxCodeLength)
splitPoint = formattedLine.length();
else
splitPoint = formattedLine.length() - 1;
// padded or unpadded arrays
if (previousNonWSChar == ']')
{
if (formattedLine.length() - 1 <= maxCodeLength)
maxWhiteSpace = splitPoint;
else
maxWhiteSpacePending = splitPoint;
}
else if (charNum > 0
&& (isLegalNameChar(currentLine[charNum - 1])
|| currentLine[charNum - 1] == ')'
|| currentLine[charNum - 1] == ']'))
{
if (formattedLine.length() <= maxCodeLength)
maxWhiteSpace = splitPoint;
else
maxWhiteSpacePending = splitPoint;
}
}
}
/**
* Update the split point when a pointer or reference is formatted.
* The argument is the maximum index of the last whitespace character.
*/
void ASFormatter::updateFormattedLineSplitPointsPointerOrReference(size_t index)
{
assert(maxCodeLength != string::npos);
assert(formattedLine.length() > 0);
assert(index < formattedLine.length());
if (!isOkToSplitFormattedLine())
return;
if (index < maxWhiteSpace) // just in case
return;
if (index <= maxCodeLength)
maxWhiteSpace = index;
else
maxWhiteSpacePending = index;
}
bool ASFormatter::isOkToSplitFormattedLine()
{
assert(maxCodeLength != string::npos);
// Is it OK to split the line?
if (shouldKeepLineUnbroken
|| isInLineComment
|| isInComment
|| isInQuote
|| isInCase
|| isInPreprocessor
|| isInExecSQL
|| isInAsm || isInAsmOneLine || isInAsmBlock
|| isInTemplate)
return false;
if (!isOkToBreakBlock(bracketTypeStack->back()) && currentChar != '{')
{
shouldKeepLineUnbroken = true;
clearFormattedLineSplitPoints();
return false;
}
else if (isBracketType(bracketTypeStack->back(), ARRAY_TYPE))
{
shouldKeepLineUnbroken = true;
if (!isBracketType(bracketTypeStack->back(), ARRAY_NIS_TYPE))
clearFormattedLineSplitPoints();
return false;
}
return true;
}
/* This is called if the option maxCodeLength is set.
*/
void ASFormatter::testForTimeToSplitFormattedLine()
{
// DO NOT ASSERT maxCodeLength HERE
// should the line be split
if (formattedLine.length() > maxCodeLength && !isLineReady)
{
size_t splitPoint = findFormattedLineSplitPoint();
if (splitPoint > 0 && splitPoint < formattedLine.length())
{
string splitLine = formattedLine.substr(splitPoint);
formattedLine = formattedLine.substr(0, splitPoint);
breakLine(true);
formattedLine = splitLine;
// if break-blocks is requested and this is a one-line statement
string nextWord = ASBeautifier::getNextWord(currentLine, charNum - 1);
if (isAppendPostBlockEmptyLineRequested
&& (nextWord == "break" || nextWord == "continue"))
{
isAppendPostBlockEmptyLineRequested = false;
isPrependPostBlockEmptyLineRequested = true;
}
else
isPrependPostBlockEmptyLineRequested = false;
// adjust max split points
maxAndOr = (maxAndOr > splitPoint) ? (maxAndOr - splitPoint) : 0;
maxSemi = (maxSemi > splitPoint) ? (maxSemi - splitPoint) : 0;
maxComma = (maxComma > splitPoint) ? (maxComma - splitPoint) : 0;
maxParen = (maxParen > splitPoint) ? (maxParen - splitPoint) : 0;
maxWhiteSpace = (maxWhiteSpace > splitPoint) ? (maxWhiteSpace - splitPoint) : 0;
if (maxSemiPending > 0)
{
maxSemi = (maxSemiPending > splitPoint) ? (maxSemiPending - splitPoint) : 0;
maxSemiPending = 0;
}
if (maxAndOrPending > 0)
{
maxAndOr = (maxAndOrPending > splitPoint) ? (maxAndOrPending - splitPoint) : 0;
maxAndOrPending = 0;
}
if (maxCommaPending > 0)
{
maxComma = (maxCommaPending > splitPoint) ? (maxCommaPending - splitPoint) : 0;
maxCommaPending = 0;
}
if (maxParenPending > 0)
{
maxParen = (maxParenPending > splitPoint) ? (maxParenPending - splitPoint) : 0;
maxParenPending = 0;
}
if (maxWhiteSpacePending > 0)
{
maxWhiteSpace = (maxWhiteSpacePending > splitPoint) ? (maxWhiteSpacePending - splitPoint) : 0;
maxWhiteSpacePending = 0;
}
// don't allow an empty formatted line
size_t firstText = formattedLine.find_first_not_of(" \t");
if (firstText == string::npos && formattedLine.length() > 0)
{
formattedLine.erase();
clearFormattedLineSplitPoints();
if (isWhiteSpace(currentChar))
for (size_t i = charNum + 1; i < currentLine.length() && isWhiteSpace(currentLine[i]); i++)
goForward(1);
}
else if (firstText > 0)
{
formattedLine.erase(0, firstText);
maxSemi = (maxSemi > firstText) ? (maxSemi - firstText) : 0;
maxAndOr = (maxAndOr > firstText) ? (maxAndOr - firstText) : 0;
maxComma = (maxComma > firstText) ? (maxComma - firstText) : 0;
maxParen = (maxParen > firstText) ? (maxParen - firstText) : 0;
maxWhiteSpace = (maxWhiteSpace > firstText) ? (maxWhiteSpace - firstText) : 0;
}
// reset formattedLineCommentNum
if (formattedLineCommentNum != string::npos)
{
formattedLineCommentNum = formattedLine.find("//");
if (formattedLineCommentNum == string::npos)
formattedLineCommentNum = formattedLine.find("/*");
}
}
}
}
size_t ASFormatter::findFormattedLineSplitPoint() const
{
assert(maxCodeLength != string::npos);
// determine where to split
size_t minCodeLength = 10;
size_t splitPoint = 0;
splitPoint = maxSemi;
if (maxAndOr >= minCodeLength)
splitPoint = maxAndOr;
if (splitPoint < minCodeLength)
{
splitPoint = maxWhiteSpace;
// use maxParen instead if it is long enough
if (maxParen > splitPoint
|| maxParen >= maxCodeLength * .7)
splitPoint = maxParen;
// use maxComma instead if it is long enough
// increasing the multiplier causes more splits at whitespace
if (maxComma > splitPoint
|| maxComma >= maxCodeLength * .3)
splitPoint = maxComma;
}
// replace split point with first available break point
if (splitPoint < minCodeLength)
{
splitPoint = string::npos;
if (maxSemiPending > 0 && maxSemiPending < splitPoint)
splitPoint = maxSemiPending;
if (maxAndOrPending > 0 && maxAndOrPending < splitPoint)
splitPoint = maxAndOrPending;
if (maxCommaPending > 0 && maxCommaPending < splitPoint)
splitPoint = maxCommaPending;
if (maxParenPending > 0 && maxParenPending < splitPoint)
splitPoint = maxParenPending;
if (maxWhiteSpacePending > 0 && maxWhiteSpacePending < splitPoint)
splitPoint = maxWhiteSpacePending;
if (splitPoint == string::npos)
splitPoint = 0;
}
// if remaining line after split is too long
else if (formattedLine.length() - splitPoint > maxCodeLength)
{
// if end of the currentLine, find a new split point
size_t newCharNum;
if (isCharPotentialHeader(currentLine, charNum))
newCharNum = getCurrentWord(currentLine, charNum).length() + charNum;
else
newCharNum = charNum + 2;
if (newCharNum + 1 > currentLine.length())
{
// don't move splitPoint from before a conditional to after
if (maxWhiteSpace > splitPoint + 3)
splitPoint = maxWhiteSpace;
if (maxParen > splitPoint)
splitPoint = maxParen;
}
}
return splitPoint;
}
void ASFormatter::clearFormattedLineSplitPoints()
{
maxSemi = 0;
maxAndOr = 0;
maxComma = 0;
maxParen = 0;
maxWhiteSpace = 0;
maxSemiPending = 0;
maxAndOrPending = 0;
maxCommaPending = 0;
maxParenPending = 0;
maxWhiteSpacePending = 0;
}
/**
* Check if a pointer symbol (->) follows on the currentLine.
*/
bool ASFormatter::pointerSymbolFollows() const
{
size_t peekNum = currentLine.find_first_not_of(" \t", charNum + 1);
if (peekNum == string::npos || currentLine.compare(peekNum, 2, "->") != 0)
return false;
return true;
}
/**
* Compute the input checksum.
* This is called as an assert so it for is debug config only
*/
bool ASFormatter::computeChecksumIn(const string ¤tLine_)
{
for (size_t i = 0; i < currentLine_.length(); i++)
if (!isWhiteSpace(currentLine_[i]))
checksumIn += currentLine_[i];
return true;
}
/**
* Adjust the input checksum for deleted chars.
* This is called as an assert so it for is debug config only
*/
bool ASFormatter::adjustChecksumIn(int adjustment)
{
checksumIn += adjustment;
return true;
}
/**
* get the value of checksumIn for unit testing
*
* @return checksumIn.
*/
size_t ASFormatter::getChecksumIn() const
{
return checksumIn;
}
/**
* Compute the output checksum.
* This is called as an assert so it is for debug config only
*/
bool ASFormatter::computeChecksumOut(const string &beautifiedLine)
{
for (size_t i = 0; i < beautifiedLine.length(); i++)
if (!isWhiteSpace(beautifiedLine[i]))
checksumOut += beautifiedLine[i];
return true;
}
/**
* Return isLineReady for the final check at end of file.
*/
bool ASFormatter::getIsLineReady() const
{
return isLineReady;
}
/**
* get the value of checksumOut for unit testing
*
* @return checksumOut.
*/
size_t ASFormatter::getChecksumOut() const
{
return checksumOut;
}
/**
* Return the difference in checksums.
* If zero all is okay.
*/
int ASFormatter::getChecksumDiff() const
{
return checksumOut - checksumIn;
}
// for unit testing
int ASFormatter::getFormatterFileType() const
{
return formatterFileType;
}
// Check if an operator follows the next word.
// The next word must be a legal name.
const string* ASFormatter::getFollowingOperator() const
{
// find next word
size_t nextNum = currentLine.find_first_not_of(" \t", charNum + 1);
if (nextNum == string::npos)
return NULL;
if (!isLegalNameChar(currentLine[nextNum]))
return NULL;
// bypass next word and following spaces
while (nextNum < currentLine.length())
{
if (!isLegalNameChar(currentLine[nextNum])
&& !isWhiteSpace(currentLine[nextNum]))
break;
nextNum++;
}
if (nextNum >= currentLine.length()
|| !isCharPotentialOperator(currentLine[nextNum])
|| currentLine[nextNum] == '/') // comment
return NULL;
const string* newOperator = ASBeautifier::findOperator(currentLine, nextNum, operators);
return newOperator;
}
// Check following data to determine if the current character is an array operator.
bool ASFormatter::isArrayOperator() const
{
assert(currentChar == '*' || currentChar == '&' || currentChar == '^');
assert(isBracketType(bracketTypeStack->back(), ARRAY_TYPE));
// find next word
size_t nextNum = currentLine.find_first_not_of(" \t", charNum + 1);
if (nextNum == string::npos)
return NULL;
if (!isLegalNameChar(currentLine[nextNum]))
return NULL;
// bypass next word and following spaces
while (nextNum < currentLine.length())
{
if (!isLegalNameChar(currentLine[nextNum])
&& !isWhiteSpace(currentLine[nextNum]))
break;
nextNum++;
}
// check for characters that indicate an operator
if (currentLine[nextNum] == ','
|| currentLine[nextNum] == '}'
|| currentLine[nextNum] == ')'
|| currentLine[nextNum] == '(')
return true;
return false;
}
// Reset the flags that indicate various statement information.
void ASFormatter::resetEndOfStatement()
{
foundQuestionMark = false;
foundNamespaceHeader = false;
foundClassHeader = false;
foundStructHeader = false;
foundInterfaceHeader = false;
foundPreDefinitionHeader = false;
foundPreCommandHeader = false;
foundPreCommandMacro = false;
foundCastOperator = false;
isInPotentialCalculation = false;
isSharpAccessor = false;
isSharpDelegate = false;
isInObjCMethodDefinition = false;
isInObjCInterface = false;
isInObjCSelector = false;
isInEnum = false;
isInExternC = false;
elseHeaderFollowsComments = false;
nonInStatementBracket = 0;
while (!questionMarkStack->empty())
questionMarkStack->pop_back();
}
// pad an Objective-C method colon
void ASFormatter::padObjCMethodColon()
{
assert(currentChar == ':');
char nextChar = peekNextChar();
if (objCColonPadMode == COLON_PAD_NONE
|| objCColonPadMode == COLON_PAD_AFTER
|| nextChar == ')')
{
// remove spaces before
for (int i = formattedLine.length() - 1; (i > -1) && isWhiteSpace(formattedLine[i]); i--)
formattedLine.erase(i);
}
else
{
// pad space before
for (int i = formattedLine.length() - 1; (i > 0) && isWhiteSpace(formattedLine[i]); i--)
if (isWhiteSpace(formattedLine[i - 1]))
formattedLine.erase(i);
appendSpacePad();
}
if (objCColonPadMode == COLON_PAD_NONE
|| objCColonPadMode == COLON_PAD_BEFORE
|| nextChar == ')')
{
// remove spaces after
// do not need to bump i since a char is erased
size_t i = charNum + 1;
while ((i < currentLine.length()) && isWhiteSpace(currentLine[i]))
currentLine.erase(i, 1);
}
else
{
// pad space after
// do not need to bump i since a char is erased
size_t i = charNum + 1;
while ((i + 1 < currentLine.length()) && isWhiteSpace(currentLine[i]))
currentLine.erase(i, 1);
if (((int) currentLine.length() > charNum + 1) && !isWhiteSpace(currentLine[charNum + 1]))
currentLine.insert(charNum + 1, " ");
}
}
// Remove the leading '*' from a comment line and indent to the next tab.
void ASFormatter::stripCommentPrefix()
{
int firstChar = formattedLine.find_first_not_of(" \t");
if (firstChar < 0)
return;
if (isInCommentStartLine)
{
// comment opener must begin the line
if (formattedLine.compare(firstChar, 2, "/*") != 0)
return;
int commentOpener = firstChar;
// ignore single line comments
int commentEnd = formattedLine.find("*/", firstChar + 2);
if (commentEnd != -1)
return;
// first char after the comment opener must be at least one indent
int followingText = formattedLine.find_first_not_of(" \t", commentOpener + 2);
if (followingText < 0)
return;
if (formattedLine[followingText] == '*' || formattedLine[followingText] == '!')
followingText = formattedLine.find_first_not_of(" \t", followingText + 1);
if (followingText < 0)
return;
if (formattedLine[followingText] == '*')
return;
int indentLen = getIndentLength();
int followingTextIndent = followingText - commentOpener;
if (followingTextIndent < indentLen)
{
string stringToInsert(indentLen - followingTextIndent, ' ');
formattedLine.insert(followingText, stringToInsert);
}
return;
}
// comment body including the closer
else if (formattedLine[firstChar] == '*')
{
if (formattedLine.compare(firstChar, 2, "*/") == 0)
{
// line starts with an end comment
formattedLine = "*/";
}
else
{
// build a new line with one indent
string newLine;
int secondChar = formattedLine.find_first_not_of(" \t", firstChar + 1);
if (secondChar < 0)
{
adjustChecksumIn(-'*');
formattedLine = newLine;
return;
}
if (formattedLine[secondChar] == '*')
return;
// replace the leading '*'
int indentLen = getIndentLength();
adjustChecksumIn(-'*');
// second char must be at least one indent
if (formattedLine.substr(0, secondChar).find('\t') != string::npos)
{
formattedLine.erase(firstChar, 1);
}
else
{
int spacesToInsert = 0;
if (secondChar >= indentLen)
spacesToInsert = secondChar;
else
spacesToInsert = indentLen;
formattedLine = string(spacesToInsert, ' ') + formattedLine.substr(secondChar);
}
// remove a trailing '*'
int lastChar = formattedLine.find_last_not_of(" \t");
if (lastChar > -1 && formattedLine[lastChar] == '*')
{
adjustChecksumIn(-'*');
formattedLine[lastChar] = ' ';
}
}
}
else
{
// first char not a '*'
// first char must be at least one indent
if (formattedLine.substr(0, firstChar).find('\t') == string::npos)
{
int indentLen = getIndentLength();
if (firstChar < indentLen)
{
string stringToInsert(indentLen, ' ');
formattedLine = stringToInsert + formattedLine.substr(firstChar);
}
}
}
}
} // end namespace astyle
astyle/src/ASLocalizer.cpp 100777 0 0 117552 12235007664 11221 0 //
// FILE ENCODING IS UTF-8 WITHOUT A BOM.
// русский 中文(简体) 日本 한국의
//
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* ASLocalizer.cpp
*
* Copyright (C) 2006-2013 by Jim Pattee
* Copyright (C) 1998-2002 by Tal Davidson
*
*
* This file is a part of Artistic Style - an indentation and
* reformatting tool for C, C++, C# and Java source files.
*
*
* Artistic Style is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Artistic Style is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Artistic Style. If not, see .
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* To add a new language:
*
* Add a new translation class to ASLocalizer.h.
* Add the Add the English-Translation pair to the constructor in ASLocalizer.cpp.
* Update the WinLangCode array, if necessary.
* Add the language code to the function setTranslationClass().
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*/
//----------------------------------------------------------------------------
// headers
//----------------------------------------------------------------------------
#include "ASLocalizer.h"
#ifdef _WIN32
#include
#endif
#ifdef _MSC_VER
#pragma warning(disable: 4996) // secure version deprecation warnings
// #pragma warning(disable: 4267) // 64 bit signed/unsigned loss of data
#endif
#ifdef __DMC__
#include
#endif
#ifdef __VMS
#define __USE_STD_IOSTREAM 1
#include
#else
#include
#endif
#include
#include
#include
#include
namespace astyle {
#ifndef ASTYLE_LIB
//----------------------------------------------------------------------------
// ASLocalizer class methods.
//----------------------------------------------------------------------------
ASLocalizer::ASLocalizer()
// Set the locale information.
{
// set language default values to english (ascii)
// this will be used if a locale or a language cannot be found
m_localeName = "UNKNOWN";
m_langID = "en";
m_lcid = 0;
m_subLangID.clear();
m_translation = NULL;
// Not all compilers support the C++ function locale::global(locale(""));
// For testing on Windows change the "Region and Language" settings or use AppLocale.
// For testing on Linux change the LANG environment variable: LANG=fr_FR.UTF-8.
// setlocale() will use the LANG environment variable on Linux.
char* localeName = setlocale(LC_ALL, "");
if (localeName == NULL) // use the english (ascii) defaults
{
fprintf(stderr, "\n%s\n\n", "Cannot set native locale, reverting to English");
setTranslationClass();
return;
}
// set the class variables
#ifdef _WIN32
size_t lcid = GetUserDefaultLCID();
setLanguageFromLCID(lcid);
#else
setLanguageFromName(localeName);
#endif
}
ASLocalizer::~ASLocalizer()
// Delete dynamically allocated memory.
{
delete m_translation;
}
#ifdef _WIN32
#ifdef __DMC__
// digital mars doesn't have these
const size_t SUBLANG_CHINESE_MACAU = 5;
const size_t LANG_HINDI = 57;
#endif
struct WinLangCode
{
size_t winLang;
char canonicalLang[3];
};
static WinLangCode wlc[] =
// primary language identifier http://msdn.microsoft.com/en-us/library/aa912554.aspx
// sublanguage identifier http://msdn.microsoft.com/en-us/library/aa913256.aspx
// language ID http://msdn.microsoft.com/en-us/library/ee797784%28v=cs.20%29.aspx
{
{ LANG_CHINESE, "zh" },
{ LANG_DUTCH, "nl" },
{ LANG_ENGLISH, "en" },
{ LANG_FINNISH, "fi" },
{ LANG_FRENCH, "fr" },
{ LANG_GERMAN, "de" },
{ LANG_HINDI, "hi" },
{ LANG_ITALIAN, "it" },
{ LANG_JAPANESE, "ja" },
{ LANG_KOREAN, "ko" },
{ LANG_POLISH, "pl" },
{ LANG_PORTUGUESE, "pt" },
{ LANG_RUSSIAN, "ru" },
{ LANG_SPANISH, "es" },
{ LANG_SWEDISH, "sv" },
{ LANG_UKRAINIAN, "uk" },
};
void ASLocalizer::setLanguageFromLCID(size_t lcid)
// Windows get the language to use from the user locale.
// NOTE: GetUserDefaultLocaleName() gets nearly the same name as Linux.
// But it needs Windows Vista or higher.
// Same with LCIDToLocaleName().
{
m_lcid = lcid;
m_langID == "en"; // default to english
size_t lang = PRIMARYLANGID(LANGIDFROMLCID(m_lcid));
size_t sublang = SUBLANGID(LANGIDFROMLCID(m_lcid));
// find language in the wlc table
size_t count = sizeof(wlc) / sizeof(wlc[0]);
for (size_t i = 0; i < count; i++ )
{
if (wlc[i].winLang == lang)
{
m_langID = wlc[i].canonicalLang;
break;
}
}
if (m_langID == "zh")
{
if (sublang == SUBLANG_CHINESE_SIMPLIFIED || sublang == SUBLANG_CHINESE_SINGAPORE)
m_subLangID = "CHS";
else
m_subLangID = "CHT"; // default
}
setTranslationClass();
}
#endif // _win32
string ASLocalizer::getLanguageID() const
// Returns the language ID in m_langID.
{
return m_langID;
}
const Translation* ASLocalizer::getTranslationClass() const
// Returns the name of the translation class in m_translation. Used for testing.
{
assert(m_translation);
return m_translation;
}
void ASLocalizer::setLanguageFromName(const char* langID)
// Linux set the language to use from the langID.
//
// the language string has the following form
//
// lang[_LANG][.encoding][@modifier]
//
// (see environ(5) in the Open Unix specification)
//
// where lang is the primary language, LANG is a sublang/territory,
// encoding is the charset to use and modifier "allows the user to select
// a specific instance of localization data within a single category"
//
// for example, the following strings are valid:
// fr
// fr_FR
// de_DE.iso88591
// de_DE@euro
// de_DE.iso88591@euro
{
// the constants describing the format of lang_LANG locale string
static const size_t LEN_LANG = 2;
m_lcid = 0;
string langStr = langID;
m_langID = langStr.substr(0, LEN_LANG);
// need the sublang for chinese
if (m_langID == "zh" && langStr[LEN_LANG] == '_')
{
string subLang = langStr.substr(LEN_LANG + 1, LEN_LANG);
if (subLang == "CN" || subLang == "SG")
m_subLangID = "CHS";
else
m_subLangID = "CHT"; // default
}
setTranslationClass();
}
const char* ASLocalizer::settext(const char* textIn) const
// Call the settext class and return the value.
{
assert(m_translation);
const string stringIn = textIn;
return m_translation->translate(stringIn).c_str();
}
void ASLocalizer::setTranslationClass()
// Return the required translation class.
// Sets the class variable m_translation from the value of m_langID.
// Get the language ID at http://msdn.microsoft.com/en-us/library/ee797784%28v=cs.20%29.aspx
{
assert(m_langID.length());
// delete previously set (--ascii option)
if (m_translation)
{
delete m_translation;
m_translation = NULL;
}
if (m_langID == "zh" && m_subLangID == "CHS")
m_translation = new ChineseSimplified;
else if (m_langID == "zh" && m_subLangID == "CHT")
m_translation = new ChineseTraditional;
else if (m_langID == "nl")
m_translation = new Dutch;
else if (m_langID == "en")
m_translation = new English;
else if (m_langID == "fi")
m_translation = new Finnish;
else if (m_langID == "fr")
m_translation = new French;
else if (m_langID == "de")
m_translation = new German;
else if (m_langID == "hi")
m_translation = new Hindi;
else if (m_langID == "it")
m_translation = new Italian;
else if (m_langID == "ja")
m_translation = new Japanese;
else if (m_langID == "ko")
m_translation = new Korean;
else if (m_langID == "pl")
m_translation = new Polish;
else if (m_langID == "pt")
m_translation = new Portuguese;
else if (m_langID == "ru")
m_translation = new Russian;
else if (m_langID == "es")
m_translation = new Spanish;
else if (m_langID == "sv")
m_translation = new Swedish;
else if (m_langID == "uk")
m_translation = new Ukrainian;
else // default
m_translation = new English;
}
//----------------------------------------------------------------------------
// Translation base class methods.
//----------------------------------------------------------------------------
void Translation::addPair(const string &english, const wstring &translated)
// Add a string pair to the translation vector.
{
pair entry (english, translated);
m_translation.push_back(entry);
}
string Translation::convertToMultiByte(const wstring &wideStr) const
// Convert wchar_t to a multibyte string using the currently assigned locale.
// Return an empty string if an error occurs.
{
static bool msgDisplayed = false;
// get length of the output excluding the NULL and validate the parameters
size_t mbLen = wcstombs(NULL, wideStr.c_str(), 0);
if (mbLen == string::npos)
{
if (!msgDisplayed)
{
fprintf(stderr, "\n%s\n\n", "Cannot convert to multi-byte string, reverting to English");
msgDisplayed = true;
}
return "";
}
// convert the characters
char* mbStr = new(nothrow) char[mbLen + 1];
if (mbStr == NULL)
{
if (!msgDisplayed)
{
fprintf(stderr, "\n%s\n\n", "Bad memory alloc for multi-byte string, reverting to English");
msgDisplayed = true;
}
return "";
}
wcstombs(mbStr, wideStr.c_str(), mbLen + 1);
// return the string
string mbTranslation = mbStr;
delete [] mbStr;
return mbTranslation;
}
size_t Translation::getTranslationVectorSize() const
// Return the translation vector size. Used for testing.
{
return m_translation.size();
}
bool Translation::getWideTranslation(const string &stringIn, wstring &wideOut) const
// Get the wide translation string. Used for testing.
{
for (size_t i = 0; i < m_translation.size(); i++)
{
if (m_translation[i].first == stringIn)
{
wideOut = m_translation[i].second;
return true;
}
}
// not found
wideOut = L"";
return false;
}
string &Translation::translate(const string &stringIn) const
// Translate a string.
// Return a static string instead of a member variable so the method can have a "const" designation.
// This allows "settext" to be called from a "const" method.
{
static string mbTranslation;
mbTranslation.clear();
for (size_t i = 0; i < m_translation.size(); i++)
{
if (m_translation[i].first == stringIn)
{
mbTranslation = convertToMultiByte(m_translation[i].second);
break;
}
}
// not found, return english
if (mbTranslation.empty())
mbTranslation = stringIn;
return mbTranslation;
}
//----------------------------------------------------------------------------
// Translation class methods.
// These classes have only a constructor which builds the language vector.
//----------------------------------------------------------------------------
ChineseSimplified::ChineseSimplified() // 中文(简体)
{
addPair("Formatted %s\n", L"格式化 %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"未改变 %s\n"); // should align with formatted
addPair("Directory %s\n", L"目录 %s\n");
addPair("Exclude %s\n", L"排除 %s\n");
addPair("Exclude (unmatched) %s\n", L"排除(无匹配项) %s\n");
addPair(" %s formatted %s unchanged ", L" %s 格式化 %s 未改变 ");
addPair(" seconds ", L" 秒 ");
addPair("%d min %d sec ", L"%d 分 %d 秒 ");
addPair("%s lines\n", L"%s 行\n");
addPair("Using default options file %s\n", L"使用默认配置文件 %s\n");
addPair("Invalid option file options:", L"无效的配置文件选项:");
addPair("Invalid command line options:", L"无效的命令行选项:");
addPair("For help on options type 'astyle -h'", L"输入 'astyle -h' 以获得有关命令行的帮助");
addPair("Cannot open options file", L"无法打开配置文件");
addPair("Cannot open directory", L"无法打开目录");
addPair("Missing filename in %s\n", L"在%s缺少文件名\n");
addPair("Recursive option with no wildcard", L"递归选项没有通配符");
addPair("Did you intend quote the filename", L"你打算引用文件名");
addPair("No file to process %s\n", L"没有文件可处理 %s\n");
addPair("Did you intend to use --recursive", L"你打算使用 --recursive");
addPair("Cannot process UTF-32 encoding", L"不能处理UTF-32编码");
addPair("\nArtistic Style has terminated", L"\nArtistic Style 已经终止运行");
}
ChineseTraditional::ChineseTraditional() // 中文(繁體)
{
addPair("Formatted %s\n", L"格式化 %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"未改變 %s\n"); // should align with formatted
addPair("Directory %s\n", L"目錄 %s\n");
addPair("Exclude %s\n", L"排除 %s\n");
addPair("Exclude (unmatched) %s\n", L"排除(無匹配項) %s\n");
addPair(" %s formatted %s unchanged ", L" %s 格式化 %s 未改變 ");
addPair(" seconds ", L" 秒 ");
addPair("%d min %d sec ", L"%d 分 %d 秒 ");
addPair("%s lines\n", L"%s 行\n");
addPair("Using default options file %s\n", L"使用默認配置文件 %s\n");
addPair("Invalid option file options:", L"無效的配置文件選項:");
addPair("Invalid command line options:", L"無效的命令行選項:");
addPair("For help on options type 'astyle -h'", L"輸入'astyle -h'以獲得有關命令行的幫助:");
addPair("Cannot open options file", L"無法打開配置文件");
addPair("Cannot open directory", L"無法打開目錄");
addPair("Missing filename in %s\n", L"在%s缺少文件名\n");
addPair("Recursive option with no wildcard", L"遞歸選項沒有通配符");
addPair("Did you intend quote the filename", L"你打算引用文件名");
addPair("No file to process %s\n", L"沒有文件可處理 %s\n");
addPair("Did you intend to use --recursive", L"你打算使用 --recursive");
addPair("Cannot process UTF-32 encoding", L"不能處理UTF-32編碼");
addPair("\nArtistic Style has terminated", L"\nArtistic Style 已經終止運行");
}
Dutch::Dutch() // Nederlandse
// build the translation vector in the Translation base class
{
addPair("Formatted %s\n", L"Geformatteerd %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"Onveranderd %s\n"); // should align with formatted
addPair("Directory %s\n", L"Directory %s\n");
addPair("Exclude %s\n", L"Uitsluiten %s\n");
addPair("Exclude (unmatched) %s\n", L"Uitgesloten (ongeëvenaarde) %s\n");
addPair(" %s formatted %s unchanged ", L" %s geformatteerd %s onveranderd ");
addPair(" seconds ", L" seconden ");
addPair("%d min %d sec ", L"%d min %d sec ");
addPair("%s lines\n", L"%s lijnen\n");
addPair("Using default options file %s\n", L"Met behulp van standaard opties bestand %s\n");
addPair("Invalid option file options:", L"Ongeldige optie file opties:");
addPair("Invalid command line options:", L"Ongeldige command line opties:");
addPair("For help on options type 'astyle -h'", L"Voor hulp bij 'astyle-h' opties het type");
addPair("Cannot open options file", L"Kan niet worden geopend options bestand");
addPair("Cannot open directory", L"Kan niet open directory");
addPair("Missing filename in %s\n", L"Ontbrekende bestandsnaam in %s\n");
addPair("Recursive option with no wildcard", L"Recursieve optie met geen wildcard");
addPair("Did you intend quote the filename", L"Heeft u van plan citaat van de bestandsnaam");
addPair("No file to process %s\n", L"Geen bestand te verwerken %s\n");
addPair("Did you intend to use --recursive", L"Hebt u van plan bent te gebruiken --recursive");
addPair("Cannot process UTF-32 encoding", L"Kan niet verwerken UTF-32 codering");
addPair("\nArtistic Style has terminated", L"\nArtistic Style heeft beëindigd");
}
English::English()
// this class is NOT translated
{}
Finnish::Finnish() // Suomeksi
// build the translation vector in the Translation base class
{
addPair("Formatted %s\n", L"Muotoiltu %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"Ennallaan %s\n"); // should align with formatted
addPair("Directory %s\n", L"Directory %s\n");
addPair("Exclude %s\n", L"Sulkea %s\n");
addPair("Exclude (unmatched) %s\n", L"Sulkea (verraton) %s\n");
addPair(" %s formatted %s unchanged ", L" %s muotoiltu %s ennallaan ");
addPair(" seconds ", L" sekuntia ");
addPair("%d min %d sec ", L"%d min %d sek ");
addPair("%s lines\n", L"%s linjat\n");
addPair("Using default options file %s\n", L"Käyttämällä oletusasetuksia tiedosto %s\n");
addPair("Invalid option file options:", L"Virheellinen vaihtoehto tiedosto vaihtoehtoja:");
addPair("Invalid command line options:", L"Virheellinen komentorivin:");
addPair("For help on options type 'astyle -h'", L"Apua vaihtoehdoista tyyppi 'astyle -h'");
addPair("Cannot open options file", L"Ei voi avata vaihtoehtoja tiedostoa");
addPair("Cannot open directory", L"Ei Open Directory");
addPair("Missing filename in %s\n", L"Puuttuvat tiedostonimi %s\n");
addPair("Recursive option with no wildcard", L"Rekursiivinen vaihtoehto ilman wildcard");
addPair("Did you intend quote the filename", L"Oletko aio lainata tiedostonimi");
addPair("No file to process %s\n", L"Ei tiedostoa käsitellä %s\n");
addPair("Did you intend to use --recursive", L"Oliko aiot käyttää --recursive");
addPair("Cannot process UTF-32 encoding", L"Ei voi käsitellä UTF-32 koodausta");
addPair("\nArtistic Style has terminated", L"\nArtistic Style on päättynyt");
}
French::French() // Française
// build the translation vector in the Translation base class
{
addPair("Formatted %s\n", L"Formaté %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"Inchangée %s\n"); // should align with formatted
addPair("Directory %s\n", L"Répertoire %s\n");
addPair("Exclude %s\n", L"Exclure %s\n");
addPair("Exclude (unmatched) %s\n", L"Exclure (non appariés) %s\n");
addPair(" %s formatted %s unchanged ", L" %s formaté %s inchangée ");
addPair(" seconds ", L" seconde ");
addPair("%d min %d sec ", L"%d min %d sec ");
addPair("%s lines\n", L"%s lignes\n");
addPair("Using default options file %s\n", L"Options par défaut utilisation du fichier %s\n");
addPair("Invalid option file options:", L"Options Blancs option du fichier:");
addPair("Invalid command line options:", L"Blancs options ligne de commande:");
addPair("For help on options type 'astyle -h'", L"Pour de l'aide sur les options tapez 'astyle -h'");
addPair("Cannot open options file", L"Impossible d'ouvrir le fichier d'options");
addPair("Cannot open directory", L"Impossible d'ouvrir le répertoire");
addPair("Missing filename in %s\n", L"Nom de fichier manquant dans %s\n");
addPair("Recursive option with no wildcard", L"Option récursive sans joker");
addPair("Did you intend quote the filename", L"Avez-vous l'intention de citer le nom de fichier");
addPair("No file to process %s\n", L"Aucun fichier à traiter %s\n");
addPair("Did you intend to use --recursive", L"Avez-vous l'intention d'utiliser --recursive");
addPair("Cannot process UTF-32 encoding", L"Impossible de traiter codage UTF-32");
addPair("\nArtistic Style has terminated", L"\nArtistic Style a mis fin");
}
German::German() // Deutsch
// build the translation vector in the Translation base class
{
addPair("Formatted %s\n", L"Formatiert %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"Unverändert %s\n"); // should align with formatted
addPair("Directory %s\n", L"Verzeichnis %s\n");
addPair("Exclude %s\n", L"Ausschließen %s\n");
addPair("Exclude (unmatched) %s\n", L"Ausschließen (unerreichte) %s\n");
addPair(" %s formatted %s unchanged ", L" %s formatiert %s unverändert ");
addPair(" seconds ", L" sekunden ");
addPair("%d min %d sec ", L"%d min %d sek ");
addPair("%s lines\n", L"%s linien\n");
addPair("Using default options file %s\n", L"Mit Standard-Optionen Dat %s\n");
addPair("Invalid option file options:", L"Ungültige Option Datei-Optionen:");
addPair("Invalid command line options:", L"Ungültige Kommandozeilen-Optionen:");
addPair("For help on options type 'astyle -h'", L"Für Hilfe zu den Optionen geben Sie 'astyle -h'");
addPair("Cannot open options file", L"Kann nicht geöffnet werden Optionsdatei");
addPair("Cannot open directory", L"Kann nicht geöffnet werden Verzeichnis");
addPair("Missing filename in %s\n", L"Missing in %s Dateiname\n");
addPair("Recursive option with no wildcard", L"Rekursive Option ohne Wildcard");
addPair("Did you intend quote the filename", L"Haben Sie die Absicht Inhalte der Dateiname");
addPair("No file to process %s\n", L"Keine Datei zu verarbeiten %s\n");
addPair("Did you intend to use --recursive", L"Haben Sie verwenden möchten --recursive");
addPair("Cannot process UTF-32 encoding", L"Nicht verarbeiten kann UTF-32 Codierung");
addPair("\nArtistic Style has terminated", L"\nArtistic Style ist beendet");
}
Hindi::Hindi() // हिन्दी
// build the translation vector in the Translation base class
{
// NOTE: Scintilla based editors (CodeBlocks) cannot always edit Hindi.
// Use Visual Studio instead.
addPair("Formatted %s\n", L"स्वरूपित किया %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"अपरिवर्तित %s\n"); // should align with formatted
addPair("Directory %s\n", L"निर्देशिका %s\n");
addPair("Exclude %s\n", L"निकालना %s\n");
addPair("Exclude (unmatched) %s\n", L"अपवर्जित (बेजोड़) %s\n");
addPair(" %s formatted %s unchanged ", L" %s स्वरूपित किया %s अपरिवर्तित ");
addPair(" seconds ", L" सेकंड ");
addPair("%d min %d sec ", L"%d मिनट %d सेकंड ");
addPair("%s lines\n", L"%s लाइनों\n");
addPair("Using default options file %s\n", L"डिफ़ॉल्ट विकल्प का उपयोग कर फ़ाइल %s\n");
addPair("Invalid option file options:", L"अवैध विकल्प फ़ाइल विकल्प हैं:");
addPair("Invalid command line options:", L"कमांड लाइन विकल्प अवैध:");
addPair("For help on options type 'astyle -h'", L"विकल्पों पर मदद के लिए प्रकार 'astyle -h'");
addPair("Cannot open options file", L"विकल्प फ़ाइल नहीं खोल सकता है");
addPair("Cannot open directory", L"निर्देशिका नहीं खोल सकता");
addPair("Missing filename in %s\n", L"लापता में फ़ाइलनाम %s\n");
addPair("Recursive option with no wildcard", L"कोई वाइल्डकार्ड साथ पुनरावर्ती विकल्प");
addPair("Did you intend quote the filename", L"क्या आप बोली फ़ाइलनाम का इरादा");
addPair("No file to process %s\n", L"कोई फ़ाइल %s प्रक्रिया के लिए\n");
addPair("Did you intend to use --recursive", L"क्या आप उपयोग करना चाहते हैं --recursive");
addPair("Cannot process UTF-32 encoding", L"UTF-32 कूटबन्धन प्रक्रिया नहीं कर सकते");
addPair("\nArtistic Style has terminated", L"\nArtistic Style समाप्त किया है");
}
Italian::Italian() // Italiano
// build the translation vector in the Translation base class
{
addPair("Formatted %s\n", L"Formattata %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"Immutato %s\n"); // should align with formatted
addPair("Directory %s\n", L"Elenco %s\n");
addPair("Exclude %s\n", L"Escludere %s\n");
addPair("Exclude (unmatched) %s\n", L"Escludere (senza pari) %s\n");
addPair(" %s formatted %s unchanged ", L" %s ormattata %s immutato ");
addPair(" seconds ", L" secondo ");
addPair("%d min %d sec ", L"%d min %d seg ");
addPair("%s lines\n", L"%s linee\n");
addPair("Using default options file %s\n", L"Utilizzando file delle opzioni di default %s\n");
addPair("Invalid option file options:", L"Opzione non valida file delle opzioni:");
addPair("Invalid command line options:", L"Opzioni della riga di comando non valido:");
addPair("For help on options type 'astyle -h'", L"Per informazioni sulle opzioni di tipo 'astyle-h'");
addPair("Cannot open options file", L"Impossibile aprire il file opzioni");
addPair("Cannot open directory", L"Impossibile aprire la directory");
addPair("Missing filename in %s\n", L"Nome del file mancante in %s\n");
addPair("Recursive option with no wildcard", L"Opzione ricorsiva senza jolly");
addPair("Did you intend quote the filename", L"Avete intenzione citare il nome del file");
addPair("No file to process %s\n", L"Nessun file al processo %s\n");
addPair("Did you intend to use --recursive", L"Hai intenzione di utilizzare --recursive");
addPair("Cannot process UTF-32 encoding", L"Non è possibile processo di codifica UTF-32");
addPair("\nArtistic Style has terminated", L"\nArtistic Style ha terminato");
}
Japanese::Japanese() // 日本
{
addPair("Formatted %s\n", L"フォーマット %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"変更 %s\n"); // should align with formatted
addPair("Directory %s\n", L"ディレクトリ %s\n");
addPair("Exclude %s\n", L"除外する %s\n");
addPair("Exclude (unmatched) %s\n", L"除外(マッチせず) %s\n");
addPair(" %s formatted %s unchanged ", L" %sフォーマット %s 変更 ");
addPair(" seconds ", L" 秒 ");
addPair("%d min %d sec ", L"%d 分 %d 秒 ");
addPair("%s lines\n", L"%s の行\n");
addPair("Using default options file %s\n", L"デフォルトの設定ファイルを使用してください %s\n");
addPair("Invalid option file options:", L"無効なコンフィギュレーションファイルオプション:");
addPair("Invalid command line options:", L"無効なコマンドラインオプション:");
addPair("For help on options type 'astyle -h'", L"コマンドラインについてのヘルプは'astyle- h'を入力してください");
addPair("Cannot open options file", L"コンフィギュレーションファイルを開くことができません");
addPair("Cannot open directory", L"ディレクトリのオープンに失敗しました");
addPair("Missing filename in %s\n", L"%s はファイル名で欠落しています\n");
addPair("Recursive option with no wildcard", L"再帰的なオプションではワイルドカードではない");
addPair("Did you intend quote the filename", L"あなたは、ファイル名を参照するつもり");
addPair("No file to process %s\n", L"いいえファイルは処理できません %s\n");
addPair("Did you intend to use --recursive", L"あなたが使用する予定 --recursive");
addPair("Cannot process UTF-32 encoding", L"UTF- 32エンコーディングを処理できない");
addPair("\nArtistic Style has terminated", L"\nArtistic Style 実行が終了しました");
}
Korean::Korean() // 한국의
{
addPair("Formatted %s\n", L"체재 %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"변하지 않은 %s\n"); // should align with formatted
addPair("Directory %s\n", L"디렉토리 %s\n");
addPair("Exclude %s\n", L"제외 %s\n");
addPair("Exclude (unmatched) %s\n", L"제외 (NO 일치) %s\n");
addPair(" %s formatted %s unchanged ", L" %s 체재 %s 변하지 않은 ");
addPair(" seconds ", L" 초 ");
addPair("%d min %d sec ", L"%d 분 %d 초 ");
addPair("%s lines\n", L"%s 라인\n");
addPair("Using default options file %s\n", L"기본 구성 파일을 사용 %s\n");
addPair("Invalid option file options:", L"잘못된 구성 파일 옵션 :");
addPair("Invalid command line options:", L"잘못된 명령줄 옵션 :");
addPair("For help on options type 'astyle -h'", L"옵션 유형 'astyle - H에 대한 도움말을 보려면");
addPair("Cannot open options file", L"구성 파일을 열 수 없습니다");
addPair("Cannot open directory", L"디렉토리를 열지 못했습니다");
addPair("Missing filename in %s\n", L"%s 의에서 누락된 파일 이름\n");
addPair("Recursive option with no wildcard", L"없이 와일드 카드로 재귀 옵션");
addPair("Did you intend quote the filename", L"당신은 파일 이름을 인용하고자나요");
addPair("No file to process %s\n", L"%s 을 (를) 처리하는 데 아무런 파일이 없습니다\n");
addPair("Did you intend to use --recursive", L"당신이 사용하고자나요 --recursive");
addPair("Cannot process UTF-32 encoding", L"UTF-32 인코딩을 처리할 수 없습니다");
addPair("\nArtistic Style has terminated", L"\nArtistic Style 종료가");
}
Polish::Polish() // Polski
// build the translation vector in the Translation base class
{
addPair("Formatted %s\n", L"Sformatowany %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"Niezmienione %s\n"); // should align with formatted
addPair("Directory %s\n", L"Katalog %s\n");
addPair("Exclude %s\n", L"Wykluczać %s\n");
addPair("Exclude (unmatched) %s\n", L"Wyklucz (niezrównany) %s\n");
addPair(" %s formatted %s unchanged ", L" %s sformatowany %s niezmienione ");
addPair(" seconds ", L" sekund ");
addPair("%d min %d sec ", L"%d min %d sek ");
addPair("%s lines\n", L"%s linii\n");
addPair("Using default options file %s\n", L"Korzystanie z domyślnej opcji %s plik\n");
addPair("Invalid option file options:", L"Nieprawidłowy opcji pliku opcji:");
addPair("Invalid command line options:", L"Nieprawidłowe opcje wiersza polecenia:");
addPair("For help on options type 'astyle -h'", L"Aby uzyskać pomoc od rodzaju opcji 'astyle -h'");
addPair("Cannot open options file", L"Nie można otworzyć pliku opcji");
addPair("Cannot open directory", L"Nie można otworzyć katalogu");
addPair("Missing filename in %s\n", L"Brakuje pliku w %s\n");
addPair("Recursive option with no wildcard", L"Rekurencyjne opcja bez symboli");
addPair("Did you intend quote the filename", L"Czy zamierza Pan podać nazwę pliku");
addPair("No file to process %s\n", L"Brak pliku do procesu %s\n");
addPair("Did you intend to use --recursive", L"Czy masz zamiar używać --recursive");
addPair("Cannot process UTF-32 encoding", L"Nie można procesu kodowania UTF-32");
addPair("\nArtistic Style has terminated", L"\nArtistic Style został zakończony");
}
Portuguese::Portuguese() // Português
// build the translation vector in the Translation base class
{
addPair("Formatted %s\n", L"Formatado %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"Inalterado %s\n"); // should align with formatted
addPair("Directory %s\n", L"Diretório %s\n");
addPair("Exclude %s\n", L"Excluir %s\n");
addPair("Exclude (unmatched) %s\n", L"Excluir (incomparável) %s\n");
addPair(" %s formatted %s unchanged ", L" %s formatado %s inalterado ");
addPair(" seconds ", L" segundo ");
addPair("%d min %d sec ", L"%d min %d seg ");
addPair("%s lines\n", L"%s linhas\n");
addPair("Using default options file %s\n", L"Usando o arquivo de opções padrão %s\n");
addPair("Invalid option file options:", L"Opções de arquivo inválido opção:");
addPair("Invalid command line options:", L"Opções de linha de comando inválida:");
addPair("For help on options type 'astyle -h'", L"Para obter ajuda sobre as opções de tipo 'astyle -h'");
addPair("Cannot open options file", L"Não é possível abrir arquivo de opções");
addPair("Cannot open directory", L"Não é possível abrir diretório");
addPair("Missing filename in %s\n", L"Filename faltando em %s\n");
addPair("Recursive option with no wildcard", L"Opção recursiva sem curinga");
addPair("Did you intend quote the filename", L"Será que você pretende citar o nome do arquivo");
addPair("No file to process %s\n", L"Nenhum arquivo para processar %s\n");
addPair("Did you intend to use --recursive", L"Será que você pretende usar --recursive");
addPair("Cannot process UTF-32 encoding", L"Não pode processar a codificação UTF-32");
addPair("\nArtistic Style has terminated", L"\nArtistic Style terminou");
}
Russian::Russian() // русский
// build the translation vector in the Translation base class
{
addPair("Formatted %s\n", L"Форматированный %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"без изменений %s\n"); // should align with formatted
addPair("Directory %s\n", L"каталог %s\n");
addPair("Exclude %s\n", L"исключать %s\n");
addPair("Exclude (unmatched) %s\n", L"Исключить (непревзойденный) %s\n");
addPair(" %s formatted %s unchanged ", L" %s Форматированный %s без изменений ");
addPair(" seconds ", L" секунды ");
addPair("%d min %d sec ", L"%d мин %d сек ");
addPair("%s lines\n", L"%s линий\n");
addPair("Using default options file %s\n", L"Использование опции по умолчанию файл %s\n");
addPair("Invalid option file options:", L"Недопустимый файл опций опцию:");
addPair("Invalid command line options:", L"Недопустимые параметры командной строки:");
addPair("For help on options type 'astyle -h'", L"Для получения справки по 'astyle -h' опций типа");
addPair("Cannot open options file", L"Не удается открыть файл параметров");
addPair("Cannot open directory", L"Не могу открыть каталог");
addPair("Missing filename in %s\n", L"Отсутствует имя файла в %s\n");
addPair("Recursive option with no wildcard", L"Рекурсивный вариант без каких-либо шаблона");
addPair("Did you intend quote the filename", L"Вы намерены цитатой файла");
addPair("No file to process %s\n", L"Нет файлов для обработки %s\n");
addPair("Did you intend to use --recursive", L"Неужели вы собираетесь использовать --recursive");
addPair("Cannot process UTF-32 encoding", L"Не удается обработать UTF-32 кодировке");
addPair("\nArtistic Style has terminated", L"\nArtistic Style прекратил");
}
Spanish::Spanish() // Español
// build the translation vector in the Translation base class
{
addPair("Formatted %s\n", L"Formato %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"Inalterado %s\n"); // should align with formatted
addPair("Directory %s\n", L"Directorio %s\n");
addPair("Exclude %s\n", L"Excluir %s\n");
addPair("Exclude (unmatched) %s\n", L"Excluir (incomparable) %s\n");
addPair(" %s formatted %s unchanged ", L" %s formato %s inalterado ");
addPair(" seconds ", L" segundo ");
addPair("%d min %d sec ", L"%d min %d seg ");
addPair("%s lines\n", L"%s líneas\n");
addPair("Using default options file %s\n", L"Uso de las opciones por defecto del archivo %s\n");
addPair("Invalid option file options:", L"Opción no válida opciones de archivo:");
addPair("Invalid command line options:", L"No válido opciones de línea de comando:");
addPair("For help on options type 'astyle -h'", L"Para obtener ayuda sobre las opciones tipo 'astyle -h'");
addPair("Cannot open options file", L"No se puede abrir el archivo de opciones");
addPair("Cannot open directory", L"No se puede abrir el directorio");
addPair("Missing filename in %s\n", L"Falta nombre del archivo en %s\n");
addPair("Recursive option with no wildcard", L"Recursiva opción sin comodín");
addPair("Did you intend quote the filename", L"Se tiene la intención de citar el nombre de archivo");
addPair("No file to process %s\n", L"No existe el fichero a procesar %s\n");
addPair("Did you intend to use --recursive", L"Se va a utilizar --recursive");
addPair("Cannot process UTF-32 encoding", L"No se puede procesar la codificación UTF-32");
addPair("\nArtistic Style has terminated", L"\nArtistic Style ha terminado");
}
Swedish::Swedish() // Svenska
// build the translation vector in the Translation base class
{
addPair("Formatted %s\n", L"Formaterade %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"Oförändrade %s\n"); // should align with formatted
addPair("Directory %s\n", L"Katalog %s\n");
addPair("Exclude %s\n", L"Uteslut %s\n");
addPair("Exclude (unmatched) %s\n", L"Uteslut (oöverträffad) %s\n");
addPair(" %s formatted %s unchanged ", L" %s formaterade %s oförändrade ");
addPair(" seconds ", L" sekunder ");
addPair("%d min %d sec ", L"%d min %d sek ");
addPair("%s lines\n", L"%s linjer\n");
addPair("Using default options file %s\n", L"Använda standardalternativ fil %s\n");
addPair("Invalid option file options:", L"Ogiltigt alternativ fil alternativ:");
addPair("Invalid command line options:", L"Ogiltig kommandoraden alternativ:");
addPair("For help on options type 'astyle -h'", L"För hjälp om alternativ typ 'astyle -h'");
addPair("Cannot open options file", L"Kan inte öppna inställningsfilen");
addPair("Cannot open directory", L"Kan inte öppna katalog");
addPair("Missing filename in %s\n", L"Saknade filnamn i %s\n");
addPair("Recursive option with no wildcard", L"Rekursiva alternativ utan jokertecken");
addPair("Did you intend quote the filename", L"Visste du tänker citera filnamnet");
addPair("No file to process %s\n", L"Ingen fil att bearbeta %s\n");
addPair("Did you intend to use --recursive", L"Har du för avsikt att använda --recursive");
addPair("Cannot process UTF-32 encoding", L"Kan inte hantera UTF-32 kodning");
addPair("\nArtistic Style has terminated", L"\nArtistic Style har upphört");
}
Ukrainian::Ukrainian() // Український
// build the translation vector in the Translation base class
{
addPair("Formatted %s\n", L"форматований %s\n"); // should align with unchanged
addPair("Unchanged %s\n", L"без змін %s\n"); // should align with formatted
addPair("Directory %s\n", L"Каталог %s\n");
addPair("Exclude %s\n", L"Виключити %s\n");
addPair("Exclude (unmatched) %s\n", L"Виключити (неперевершений) %s\n");
addPair(" %s formatted %s unchanged ", L" %s відформатований %s без змін ");
addPair(" seconds ", L" секунди ");
addPair("%d min %d sec ", L"%d хви %d cek ");
addPair("%s lines\n", L"%s ліній\n");
addPair("Using default options file %s\n", L"Використання файлів опцій за замовчуванням %s\n");
addPair("Invalid option file options:", L"Неприпустимий файл опцій опцію:");
addPair("Invalid command line options:", L"Неприпустима параметри командного рядка:");
addPair("For help on options type 'astyle -h'", L"Для отримання довідки по 'astyle -h' опцій типу");
addPair("Cannot open options file", L"Не вдається відкрити файл параметрів");
addPair("Cannot open directory", L"Не можу відкрити каталог");
addPair("Missing filename in %s\n", L"Відсутня назва файлу в %s\n");
addPair("Recursive option with no wildcard", L"Рекурсивний варіант без будь-яких шаблону");
addPair("Did you intend quote the filename", L"Ви маєте намір цитатою файлу");
addPair("No file to process %s\n", L"Немає файлів для обробки %s\n");
addPair("Did you intend to use --recursive", L"Невже ви збираєтеся використовувати --recursive");
addPair("Cannot process UTF-32 encoding", L"Не вдається обробити UTF-32 кодуванні");
addPair("\nArtistic Style has terminated", L"\nArtistic Style припинив");
}
#endif // ASTYLE_LIB
} // end of namespace astyle
astyle/src/ASLocalizer.h 100777 0 0 11522 12235007664 10634 0 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* ASLocalizer.h
*
* Copyright (C) 2006-2013 by Jim Pattee
* Copyright (C) 1998-2002 by Tal Davidson
*
*
* This file is a part of Artistic Style - an indentation and
* reformatting tool for C, C++, C# and Java source files.
*
*
* Artistic Style is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Artistic Style is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Artistic Style. If not, see .
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*/
#ifndef ASLOCALIZER_H
#define ASLOCALIZER_H
#include
#include
using namespace std;
namespace astyle {
#ifndef ASTYLE_LIB
//-----------------------------------------------------------------------------
// ASLocalizer class for console build.
// This class encapsulates all language-dependent settings and is a
// generalization of the C locale concept.
//-----------------------------------------------------------------------------
class Translation;
class ASLocalizer
{
public: // functions
ASLocalizer();
virtual ~ASLocalizer();
string getLanguageID() const;
const Translation* getTranslationClass() const;
#ifdef _WIN32
void setLanguageFromLCID(size_t lcid);
#endif
void setLanguageFromName(const char* langID);
const char* settext(const char* textIn) const;
private: // functions
void setTranslationClass();
private: // variables
Translation* m_translation; // pointer to a polymorphic Translation class
string m_langID; // language identifier from the locale
string m_subLangID; // sub language identifier, if needed
string m_localeName; // name of the current locale (Linux only)
size_t m_lcid; // LCID of the user locale (Windows only)
};
//----------------------------------------------------------------------------
// Translation base class.
//----------------------------------------------------------------------------
class Translation
// This base class is inherited by the language translation classes.
// Polymorphism is used to call the correct language translator.
// This class contains the translation vector and settext translation method.
// The language vector is built by the language sub classes.
// NOTE: This class must have virtual methods for typeid() to work.
// typeid() is used by AStyleTestI18n_Localizer.cpp.
{
public:
Translation() {}
virtual ~Translation() {}
string convertToMultiByte(const wstring &wideStr) const;
size_t getTranslationVectorSize() const;
bool getWideTranslation(const string &stringIn, wstring &wideOut) const;
string &translate(const string &stringIn) const;
protected:
void addPair(const string &english, const wstring &translated);
// variables
vector > m_translation; // translation vector
};
//----------------------------------------------------------------------------
// Translation classes
// One class for each language.
// These classes have only a constructor which builds the language vector.
//----------------------------------------------------------------------------
class ChineseSimplified : public Translation
{
public:
ChineseSimplified();
};
class ChineseTraditional : public Translation
{
public:
ChineseTraditional();
};
class Dutch : public Translation
{
public:
Dutch();
};
class English : public Translation
{
public:
English();
};
class Finnish : public Translation
{
public:
Finnish();
};
class French : public Translation
{
public:
French();
};
class German : public Translation
{
public:
German();
};
class Hindi : public Translation
{
public:
Hindi();
};
class Italian : public Translation
{
public:
Italian();
};
class Japanese : public Translation
{
public:
Japanese();
};
class Korean : public Translation
{
public:
Korean();
};
class Polish : public Translation
{
public:
Polish();
};
class Portuguese : public Translation
{
public:
Portuguese();
};
class Russian : public Translation
{
public:
Russian();
};
class Spanish : public Translation
{
public:
Spanish();
};
class Swedish : public Translation
{
public:
Swedish();
};
class Ukrainian : public Translation
{
public:
Ukrainian();
};
#endif // ASTYLE_LIB
} // namespace astyle
#endif // ASLOCALIZER_H
astyle/src/ASResource.cpp 100777 0 0 47172 12235007664 11044 0 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* ASResource.cpp
*
* Copyright (C) 2006-2013 by Jim Pattee
* Copyright (C) 1998-2002 by Tal Davidson
*
*
* This file is a part of Artistic Style - an indentation and
* reformatting tool for C, C++, C# and Java source files.
*
*
* Artistic Style is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Artistic Style is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Artistic Style. If not, see .
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*/
#include "astyle.h"
#include
namespace astyle {
const string ASResource::AS_IF = string("if");
const string ASResource::AS_ELSE = string("else");
const string ASResource::AS_FOR = string("for");
const string ASResource::AS_DO = string("do");
const string ASResource::AS_WHILE = string("while");
const string ASResource::AS_SWITCH = string("switch");
const string ASResource::AS_CASE = string("case");
const string ASResource::AS_DEFAULT = string("default");
const string ASResource::AS_CLASS = string("class");
const string ASResource::AS_VOLATILE = string("volatile");
const string ASResource::AS_STRUCT = string("struct");
const string ASResource::AS_UNION = string("union");
const string ASResource::AS_INTERFACE = string("interface");
const string ASResource::AS_NAMESPACE = string("namespace");
const string ASResource::AS_END = string("end");
const string ASResource::AS_SELECTOR = string("selector");
const string ASResource::AS_EXTERN = string("extern");
const string ASResource::AS_ENUM = string("enum");
const string ASResource::AS_PUBLIC = string("public");
const string ASResource::AS_PROTECTED = string("protected");
const string ASResource::AS_PRIVATE = string("private");
const string ASResource::AS_STATIC = string("static");
const string ASResource::AS_SYNCHRONIZED = string("synchronized");
const string ASResource::AS_OPERATOR = string("operator");
const string ASResource::AS_TEMPLATE = string("template");
const string ASResource::AS_TRY = string("try");
const string ASResource::AS_CATCH = string("catch");
const string ASResource::AS_THROW = string("throw");
const string ASResource::AS_FINALLY = string("finally");
const string ASResource::_AS_TRY = string("__try");
const string ASResource::_AS_FINALLY = string("__finally");
const string ASResource::_AS_EXCEPT = string("__except");
const string ASResource::AS_THROWS = string("throws");
const string ASResource::AS_CONST = string("const");
const string ASResource::AS_SEALED = string("sealed");
const string ASResource::AS_OVERRIDE = string("override");
const string ASResource::AS_WHERE = string("where");
const string ASResource::AS_NEW = string("new");
const string ASResource::AS_ASM = string("asm");
const string ASResource::AS__ASM__ = string("__asm__");
const string ASResource::AS_MS_ASM = string("_asm");
const string ASResource::AS_MS__ASM = string("__asm");
const string ASResource::AS_BAR_DEFINE = string("#define");
const string ASResource::AS_BAR_INCLUDE = string("#include");
const string ASResource::AS_BAR_IF = string("#if");
const string ASResource::AS_BAR_EL = string("#el");
const string ASResource::AS_BAR_ENDIF = string("#endif");
const string ASResource::AS_OPEN_BRACKET = string("{");
const string ASResource::AS_CLOSE_BRACKET = string("}");
const string ASResource::AS_OPEN_LINE_COMMENT = string("//");
const string ASResource::AS_OPEN_COMMENT = string("/*");
const string ASResource::AS_CLOSE_COMMENT = string("*/");
const string ASResource::AS_ASSIGN = string("=");
const string ASResource::AS_PLUS_ASSIGN = string("+=");
const string ASResource::AS_MINUS_ASSIGN = string("-=");
const string ASResource::AS_MULT_ASSIGN = string("*=");
const string ASResource::AS_DIV_ASSIGN = string("/=");
const string ASResource::AS_MOD_ASSIGN = string("%=");
const string ASResource::AS_OR_ASSIGN = string("|=");
const string ASResource::AS_AND_ASSIGN = string("&=");
const string ASResource::AS_XOR_ASSIGN = string("^=");
const string ASResource::AS_GR_GR_ASSIGN = string(">>=");
const string ASResource::AS_LS_LS_ASSIGN = string("<<=");
const string ASResource::AS_GR_GR_GR_ASSIGN = string(">>>=");
const string ASResource::AS_LS_LS_LS_ASSIGN = string("<<<=");
const string ASResource::AS_GCC_MIN_ASSIGN = string("");
const string ASResource::AS_GCC_MAX_ASSIGN = string(">?");
const string ASResource::AS_RETURN = string("return");
const string ASResource::AS_CIN = string("cin");
const string ASResource::AS_COUT = string("cout");
const string ASResource::AS_CERR = string("cerr");
const string ASResource::AS_EQUAL = string("==");
const string ASResource::AS_PLUS_PLUS = string("++");
const string ASResource::AS_MINUS_MINUS = string("--");
const string ASResource::AS_NOT_EQUAL = string("!=");
const string ASResource::AS_GR_EQUAL = string(">=");
const string ASResource::AS_GR_GR = string(">>");
const string ASResource::AS_GR_GR_GR = string(">>>");
const string ASResource::AS_LS_EQUAL = string("<=");
const string ASResource::AS_LS_LS = string("<<");
const string ASResource::AS_LS_LS_LS = string("<<<");
const string ASResource::AS_QUESTION_QUESTION = string("??");
const string ASResource::AS_LAMBDA = string("=>"); // C# lambda expression arrow
const string ASResource::AS_ARROW = string("->");
const string ASResource::AS_AND = string("&&");
const string ASResource::AS_OR = string("||");
const string ASResource::AS_SCOPE_RESOLUTION = string("::");
const string ASResource::AS_PLUS = string("+");
const string ASResource::AS_MINUS = string("-");
const string ASResource::AS_MULT = string("*");
const string ASResource::AS_DIV = string("/");
const string ASResource::AS_MOD = string("%");
const string ASResource::AS_GR = string(">");
const string ASResource::AS_LS = string("<");
const string ASResource::AS_NOT = string("!");
const string ASResource::AS_BIT_OR = string("|");
const string ASResource::AS_BIT_AND = string("&");
const string ASResource::AS_BIT_NOT = string("~");
const string ASResource::AS_BIT_XOR = string("^");
const string ASResource::AS_QUESTION = string("?");
const string ASResource::AS_COLON = string(":");
const string ASResource::AS_COMMA = string(",");
const string ASResource::AS_SEMICOLON = string(";");
const string ASResource::AS_FOREACH = string("foreach");
const string ASResource::AS_LOCK = string("lock");
const string ASResource::AS_UNSAFE = string("unsafe");
const string ASResource::AS_FIXED = string("fixed");
const string ASResource::AS_GET = string("get");
const string ASResource::AS_SET = string("set");
const string ASResource::AS_ADD = string("add");
const string ASResource::AS_REMOVE = string("remove");
const string ASResource::AS_DELEGATE = string("delegate");
const string ASResource::AS_UNCHECKED = string("unchecked");
const string ASResource::AS_CONST_CAST = string("const_cast");
const string ASResource::AS_DYNAMIC_CAST = string("dynamic_cast");
const string ASResource::AS_REINTERPRET_CAST = string("reinterpret_cast");
const string ASResource::AS_STATIC_CAST = string("static_cast");
const string ASResource::AS_NS_DURING = string("NS_DURING");
const string ASResource::AS_NS_HANDLER = string("NS_HANDLER");
/**
* Sort comparison function.
* Compares the length of the value of pointers in the vectors.
* The LONGEST strings will be first in the vector.
*
* @params the string pointers to be compared.
*/
bool sortOnLength(const string* a, const string* b)
{
return (*a).length() > (*b).length();
}
/**
* Sort comparison function.
* Compares the value of pointers in the vectors.
*
* @params the string pointers to be compared.
*/
bool sortOnName(const string* a, const string* b)
{
return *a < *b;
}
/**
* Build the vector of assignment operators.
* Used by BOTH ASFormatter.cpp and ASBeautifier.cpp
*
* @param assignmentOperators a reference to the vector to be built.
*/
void ASResource::buildAssignmentOperators(vector* assignmentOperators)
{
assignmentOperators->push_back(&AS_ASSIGN);
assignmentOperators->push_back(&AS_PLUS_ASSIGN);
assignmentOperators->push_back(&AS_MINUS_ASSIGN);
assignmentOperators->push_back(&AS_MULT_ASSIGN);
assignmentOperators->push_back(&AS_DIV_ASSIGN);
assignmentOperators->push_back(&AS_MOD_ASSIGN);
assignmentOperators->push_back(&AS_OR_ASSIGN);
assignmentOperators->push_back(&AS_AND_ASSIGN);
assignmentOperators->push_back(&AS_XOR_ASSIGN);
// Java
assignmentOperators->push_back(&AS_GR_GR_GR_ASSIGN);
assignmentOperators->push_back(&AS_GR_GR_ASSIGN);
assignmentOperators->push_back(&AS_LS_LS_ASSIGN);
// Unknown
assignmentOperators->push_back(&AS_LS_LS_LS_ASSIGN);
sort(assignmentOperators->begin(), assignmentOperators->end(), sortOnLength);
}
/**
* Build the vector of C++ cast operators.
* Used by ONLY ASFormatter.cpp
*
* @param castOperators a reference to the vector to be built.
*/
void ASResource::buildCastOperators(vector* castOperators)
{
castOperators->push_back(&AS_CONST_CAST);
castOperators->push_back(&AS_DYNAMIC_CAST);
castOperators->push_back(&AS_REINTERPRET_CAST);
castOperators->push_back(&AS_STATIC_CAST);
}
/**
* Build the vector of header words.
* Used by BOTH ASFormatter.cpp and ASBeautifier.cpp
*
* @param headers a reference to the vector to be built.
*/
void ASResource::buildHeaders(vector* headers, int fileType, bool beautifier)
{
headers->push_back(&AS_IF);
headers->push_back(&AS_ELSE);
headers->push_back(&AS_FOR);
headers->push_back(&AS_WHILE);
headers->push_back(&AS_DO);
headers->push_back(&AS_SWITCH);
headers->push_back(&AS_CASE);
headers->push_back(&AS_DEFAULT);
headers->push_back(&AS_TRY);
headers->push_back(&AS_CATCH);
if (fileType == C_TYPE)
{
headers->push_back(&_AS_TRY); // __try
headers->push_back(&_AS_FINALLY); // __finally
headers->push_back(&_AS_EXCEPT); // __except
}
if (fileType == JAVA_TYPE)
{
headers->push_back(&AS_FINALLY);
headers->push_back(&AS_SYNCHRONIZED);
}
if (fileType == SHARP_TYPE)
{
headers->push_back(&AS_FINALLY);
headers->push_back(&AS_FOREACH);
headers->push_back(&AS_LOCK);
headers->push_back(&AS_FIXED);
headers->push_back(&AS_GET);
headers->push_back(&AS_SET);
headers->push_back(&AS_ADD);
headers->push_back(&AS_REMOVE);
}
if (beautifier)
{
if (fileType == C_TYPE)
{
headers->push_back(&AS_TEMPLATE);
}
if (fileType == JAVA_TYPE)
{
headers->push_back(&AS_STATIC); // for static constructor
}
}
sort(headers->begin(), headers->end(), sortOnName);
}
/**
* Build the vector of indentable headers.
* Used by ONLY ASBeautifier.cpp
*
* @param indentableHeaders a reference to the vector to be built.
*/
void ASResource::buildIndentableHeaders(vector* indentableHeaders)
{
indentableHeaders->push_back(&AS_RETURN);
sort(indentableHeaders->begin(), indentableHeaders->end(), sortOnName);
}
/**
* Build the vector of non-assignment operators.
* Used by ONLY ASBeautifier.cpp
*
* @param nonAssignmentOperators a reference to the vector to be built.
*/
void ASResource::buildNonAssignmentOperators(vector* nonAssignmentOperators)
{
nonAssignmentOperators->push_back(&AS_EQUAL);
nonAssignmentOperators->push_back(&AS_PLUS_PLUS);
nonAssignmentOperators->push_back(&AS_MINUS_MINUS);
nonAssignmentOperators->push_back(&AS_NOT_EQUAL);
nonAssignmentOperators->push_back(&AS_GR_EQUAL);
nonAssignmentOperators->push_back(&AS_GR_GR_GR);
nonAssignmentOperators->push_back(&AS_GR_GR);
nonAssignmentOperators->push_back(&AS_LS_EQUAL);
nonAssignmentOperators->push_back(&AS_LS_LS_LS);
nonAssignmentOperators->push_back(&AS_LS_LS);
nonAssignmentOperators->push_back(&AS_ARROW);
nonAssignmentOperators->push_back(&AS_AND);
nonAssignmentOperators->push_back(&AS_OR);
nonAssignmentOperators->push_back(&AS_LAMBDA);
sort(nonAssignmentOperators->begin(), nonAssignmentOperators->end(), sortOnLength);
}
/**
* Build the vector of header non-paren headers.
* Used by BOTH ASFormatter.cpp and ASBeautifier.cpp.
* NOTE: Non-paren headers should also be included in the headers vector.
*
* @param nonParenHeaders a reference to the vector to be built.
*/
void ASResource::buildNonParenHeaders(vector* nonParenHeaders, int fileType, bool beautifier)
{
nonParenHeaders->push_back(&AS_ELSE);
nonParenHeaders->push_back(&AS_DO);
nonParenHeaders->push_back(&AS_TRY);
nonParenHeaders->push_back(&AS_CATCH); // can be paren or non-paren
nonParenHeaders->push_back(&AS_CASE); // can be paren or non-paren
nonParenHeaders->push_back(&AS_DEFAULT);
if (fileType == C_TYPE)
{
nonParenHeaders->push_back(&_AS_TRY); // __try
nonParenHeaders->push_back(&_AS_FINALLY); // __finally
}
if (fileType == JAVA_TYPE)
{
nonParenHeaders->push_back(&AS_FINALLY);
}
if (fileType == SHARP_TYPE)
{
nonParenHeaders->push_back(&AS_FINALLY);
nonParenHeaders->push_back(&AS_GET);
nonParenHeaders->push_back(&AS_SET);
nonParenHeaders->push_back(&AS_ADD);
nonParenHeaders->push_back(&AS_REMOVE);
}
if (beautifier)
{
if (fileType == C_TYPE)
{
nonParenHeaders->push_back(&AS_TEMPLATE);
}
if (fileType == JAVA_TYPE)
{
nonParenHeaders->push_back(&AS_STATIC);
}
}
sort(nonParenHeaders->begin(), nonParenHeaders->end(), sortOnName);
}
/**
* Build the vector of operators.
* Used by ONLY ASFormatter.cpp
*
* @param operators a reference to the vector to be built.
*/
void ASResource::buildOperators(vector* operators, int fileType)
{
operators->push_back(&AS_PLUS_ASSIGN);
operators->push_back(&AS_MINUS_ASSIGN);
operators->push_back(&AS_MULT_ASSIGN);
operators->push_back(&AS_DIV_ASSIGN);
operators->push_back(&AS_MOD_ASSIGN);
operators->push_back(&AS_OR_ASSIGN);
operators->push_back(&AS_AND_ASSIGN);
operators->push_back(&AS_XOR_ASSIGN);
operators->push_back(&AS_EQUAL);
operators->push_back(&AS_PLUS_PLUS);
operators->push_back(&AS_MINUS_MINUS);
operators->push_back(&AS_NOT_EQUAL);
operators->push_back(&AS_GR_EQUAL);
operators->push_back(&AS_GR_GR_GR_ASSIGN);
operators->push_back(&AS_GR_GR_ASSIGN);
operators->push_back(&AS_GR_GR_GR);
operators->push_back(&AS_GR_GR);
operators->push_back(&AS_LS_EQUAL);
operators->push_back(&AS_LS_LS_LS_ASSIGN);
operators->push_back(&AS_LS_LS_ASSIGN);
operators->push_back(&AS_LS_LS_LS);
operators->push_back(&AS_LS_LS);
operators->push_back(&AS_QUESTION_QUESTION);
operators->push_back(&AS_LAMBDA);
operators->push_back(&AS_ARROW);
operators->push_back(&AS_AND);
operators->push_back(&AS_OR);
operators->push_back(&AS_SCOPE_RESOLUTION);
operators->push_back(&AS_PLUS);
operators->push_back(&AS_MINUS);
operators->push_back(&AS_MULT);
operators->push_back(&AS_DIV);
operators->push_back(&AS_MOD);
operators->push_back(&AS_QUESTION);
operators->push_back(&AS_COLON);
operators->push_back(&AS_ASSIGN);
operators->push_back(&AS_LS);
operators->push_back(&AS_GR);
operators->push_back(&AS_NOT);
operators->push_back(&AS_BIT_OR);
operators->push_back(&AS_BIT_AND);
operators->push_back(&AS_BIT_NOT);
operators->push_back(&AS_BIT_XOR);
if (fileType == C_TYPE)
{
operators->push_back(&AS_GCC_MIN_ASSIGN);
operators->push_back(&AS_GCC_MAX_ASSIGN);
}
sort(operators->begin(), operators->end(), sortOnLength);
}
/**
* Build the vector of pre-block statements.
* Used by ONLY ASBeautifier.cpp
* NOTE: Cannot be both a header and a preBlockStatement.
*
* @param preBlockStatements a reference to the vector to be built.
*/
void ASResource::buildPreBlockStatements(vector* preBlockStatements, int fileType)
{
preBlockStatements->push_back(&AS_CLASS);
if (fileType == C_TYPE)
{
preBlockStatements->push_back(&AS_STRUCT);
preBlockStatements->push_back(&AS_UNION);
preBlockStatements->push_back(&AS_NAMESPACE);
}
if (fileType == JAVA_TYPE)
{
preBlockStatements->push_back(&AS_INTERFACE);
preBlockStatements->push_back(&AS_THROWS);
}
if (fileType == SHARP_TYPE)
{
preBlockStatements->push_back(&AS_INTERFACE);
preBlockStatements->push_back(&AS_NAMESPACE);
preBlockStatements->push_back(&AS_WHERE);
preBlockStatements->push_back(&AS_STRUCT);
}
sort(preBlockStatements->begin(), preBlockStatements->end(), sortOnName);
}
/**
* Build the vector of pre-command headers.
* Used by BOTH ASFormatter.cpp and ASBeautifier.cpp.
* NOTE: Cannot be both a header and a preCommandHeader.
*
* A preCommandHeader is in a function definition between
* the closing paren and the opening bracket.
* e.g. in "void foo() const {}", "const" is a preCommandHeader.
*/
void ASResource::buildPreCommandHeaders(vector* preCommandHeaders, int fileType)
{
if (fileType == C_TYPE)
{
preCommandHeaders->push_back(&AS_CONST);
preCommandHeaders->push_back(&AS_VOLATILE);
preCommandHeaders->push_back(&AS_SEALED); // Visual C only
preCommandHeaders->push_back(&AS_OVERRIDE); // Visual C only
}
if (fileType == JAVA_TYPE)
{
preCommandHeaders->push_back(&AS_THROWS);
}
if (fileType == SHARP_TYPE)
{
preCommandHeaders->push_back(&AS_WHERE);
}
sort(preCommandHeaders->begin(), preCommandHeaders->end(), sortOnName);
}
/**
* Build the vector of pre-definition headers.
* Used by ONLY ASFormatter.cpp
* NOTE: Do NOT add 'enum' here. It is an array type bracket.
* NOTE: Do NOT add 'extern' here. Do not want an extra indent.
*
* @param preDefinitionHeaders a reference to the vector to be built.
*/
void ASResource::buildPreDefinitionHeaders(vector* preDefinitionHeaders, int fileType)
{
preDefinitionHeaders->push_back(&AS_CLASS);
if (fileType == C_TYPE)
{
preDefinitionHeaders->push_back(&AS_STRUCT);
preDefinitionHeaders->push_back(&AS_UNION);
preDefinitionHeaders->push_back(&AS_NAMESPACE);
}
if (fileType == JAVA_TYPE)
{
preDefinitionHeaders->push_back(&AS_INTERFACE);
}
if (fileType == SHARP_TYPE)
{
preDefinitionHeaders->push_back(&AS_STRUCT);
preDefinitionHeaders->push_back(&AS_INTERFACE);
preDefinitionHeaders->push_back(&AS_NAMESPACE);
}
sort(preDefinitionHeaders->begin(), preDefinitionHeaders->end(), sortOnName);
}
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* ASBase Functions
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
// check if a specific line position contains a keyword.
bool ASBase::findKeyword(const string &line, int i, const string &keyword) const
{
assert(isCharPotentialHeader(line, i));
// check the word
const size_t keywordLength = keyword.length();
const size_t wordEnd = i + keywordLength;
if (wordEnd > line.length())
return false;
if (line.compare(i, keywordLength, keyword) != 0)
return false;
// check that this is not part of a longer word
if (wordEnd == line.length())
return true;
if (isLegalNameChar(line[wordEnd]))
return false;
// is not a keyword if part of a definition
const char peekChar = peekNextChar(line, wordEnd - 1);
if (peekChar == ',' || peekChar == ')')
return false;
return true;
}
// get the current word on a line
// index must point to the beginning of the word
string ASBase::getCurrentWord(const string &line, size_t index) const
{
assert(isCharPotentialHeader(line, index));
size_t lineLength = line.length();
size_t i;
for (i = index; i < lineLength; i++)
{
if (!isLegalNameChar(line[i]))
break;
}
return line.substr(index, i - index);
}
} // end namespace astyle
astyle/src/astyle.h 100777 0 0 105036 12235007664 10011 0 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* astyle.h
*
* Copyright (C) 2006-2013 by Jim Pattee
* Copyright (C) 1998-2002 by Tal Davidson
*
*
* This file is a part of Artistic Style - an indentation and
* reformatting tool for C, C++, C# and Java source files.
*
*
* Artistic Style is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Artistic Style is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Artistic Style. If not, see .
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*/
#ifndef ASTYLE_H
#define ASTYLE_H
#ifdef __VMS
#define __USE_STD_IOSTREAM 1
#include
#else
#include
#endif
#include
#include // for cout
#include
#include
#if defined(__GNUC__)
#include // need both string and string.h for GCC
#endif
// define STDCALL and EXPORT for Windows
// MINGW defines STDCALL in Windows.h (actually windef.h)
// EXPORT has no value for Visual C if ASTYLE_NO_VCX (no VC Exports) is defined
#ifdef _WIN32
#ifndef STDCALL
#define STDCALL __stdcall
#endif
#if defined(_MSC_VER) && defined(ASTYLE_NO_VCX)
#define EXPORT
#else
#define EXPORT __declspec(dllexport)
#endif
// define STDCALL and EXPORT for non-Windows
#else
#define STDCALL
#define EXPORT
#endif // #ifdef _WIN32
#ifdef _MSC_VER
#pragma warning(disable: 4996) // secure version deprecation warnings
#pragma warning(disable: 4267) // 64 bit signed/unsigned loss of data
#endif
#ifdef __BORLANDC__
#pragma warn -8004 // variable is assigned a value that is never used
#endif
#ifdef __INTEL_COMPILER
#pragma warning(disable: 383) // value copied to temporary, reference to temporary used
// #pragma warning(disable: 444) // destructor for base class is not virtual
#pragma warning(disable: 981) // operands are evaluated in unspecified order
#endif
using namespace std;
namespace astyle {
enum FileType { C_TYPE = 0, JAVA_TYPE = 1, SHARP_TYPE = 2 };
/* The enums below are not recognized by 'vectors' in Microsoft Visual C++
V5 when they are part of a namespace!!! Use Visual C++ V6 or higher.
*/
enum FormatStyle
{
STYLE_NONE,
STYLE_ALLMAN,
STYLE_JAVA,
STYLE_KR,
STYLE_STROUSTRUP,
STYLE_WHITESMITH,
STYLE_BANNER,
STYLE_GNU,
STYLE_LINUX,
STYLE_HORSTMANN,
STYLE_1TBS,
STYLE_GOOGLE,
STYLE_PICO,
STYLE_LISP
};
enum BracketMode
{
NONE_MODE,
ATTACH_MODE,
BREAK_MODE,
LINUX_MODE,
STROUSTRUP_MODE,
RUN_IN_MODE
};
enum BracketType
{
NULL_TYPE = 0,
NAMESPACE_TYPE = 1, // also a DEFINITION_TYPE
CLASS_TYPE = 2, // also a DEFINITION_TYPE
STRUCT_TYPE = 4, // also a DEFINITION_TYPE
INTERFACE_TYPE = 8, // also a DEFINITION_TYPE
DEFINITION_TYPE = 16,
COMMAND_TYPE = 32,
ARRAY_NIS_TYPE = 64, // also an ARRAY_TYPE
ARRAY_TYPE = 128, // arrays and enums
EXTERN_TYPE = 256, // extern "C", not a command type extern
SINGLE_LINE_TYPE = 512
};
enum MinConditional
{
MINCOND_ZERO,
MINCOND_ONE,
MINCOND_TWO,
MINCOND_ONEHALF,
MINCOND_END
};
enum ObjCColonPad
{
COLON_PAD_NO_CHANGE,
COLON_PAD_NONE,
COLON_PAD_ALL,
COLON_PAD_AFTER,
COLON_PAD_BEFORE
};
enum PointerAlign
{
PTR_ALIGN_NONE,
PTR_ALIGN_TYPE,
PTR_ALIGN_MIDDLE,
PTR_ALIGN_NAME
};
enum ReferenceAlign
{
REF_ALIGN_NONE = PTR_ALIGN_NONE,
REF_ALIGN_TYPE = PTR_ALIGN_TYPE,
REF_ALIGN_MIDDLE = PTR_ALIGN_MIDDLE,
REF_ALIGN_NAME = PTR_ALIGN_NAME,
REF_SAME_AS_PTR
};
enum FileEncoding
{
ENCODING_8BIT,
UTF_16BE,
UTF_16LE,
UTF_32BE,
UTF_32LE
};
enum LineEndFormat
{
LINEEND_DEFAULT, // Use line break that matches most of the file
LINEEND_WINDOWS,
LINEEND_LINUX,
LINEEND_MACOLD,
LINEEND_CRLF = LINEEND_WINDOWS,
LINEEND_LF = LINEEND_LINUX,
LINEEND_CR = LINEEND_MACOLD
};
//-----------------------------------------------------------------------------
// Class ASSourceIterator
// A pure virtual class is used by ASFormatter and ASBeautifier instead of
// ASStreamIterator. This allows programs using AStyle as a plugin to define
// their own ASStreamIterator. The ASStreamIterator class must inherit
// this class.
//-----------------------------------------------------------------------------
class ASSourceIterator
{
public:
ASSourceIterator() {}
virtual ~ASSourceIterator() {}
virtual bool hasMoreLines() const = 0;
virtual string nextLine(bool emptyLineWasDeleted = false) = 0;
virtual string peekNextLine() = 0;
virtual void peekReset() = 0;
};
//-----------------------------------------------------------------------------
// Class ASResource
//-----------------------------------------------------------------------------
class ASResource
{
public:
ASResource() {}
virtual ~ASResource() {}
void buildAssignmentOperators(vector* assignmentOperators);
void buildCastOperators(vector* castOperators);
void buildHeaders(vector* headers, int fileType, bool beautifier = false);
void buildIndentableHeaders(vector* indentableHeaders);
void buildNonAssignmentOperators(vector* nonAssignmentOperators);
void buildNonParenHeaders(vector* nonParenHeaders, int fileType, bool beautifier = false);
void buildOperators(vector* operators, int fileType);
void buildPreBlockStatements(vector* preBlockStatements, int fileType);
void buildPreCommandHeaders(vector* preCommandHeaders, int fileType);
void buildPreDefinitionHeaders(vector* preDefinitionHeaders, int fileType);
public:
static const string AS_IF, AS_ELSE;
static const string AS_DO, AS_WHILE;
static const string AS_FOR;
static const string AS_SWITCH, AS_CASE, AS_DEFAULT;
static const string AS_TRY, AS_CATCH, AS_THROW, AS_THROWS, AS_FINALLY;
static const string _AS_TRY, _AS_FINALLY, _AS_EXCEPT;
static const string AS_PUBLIC, AS_PROTECTED, AS_PRIVATE;
static const string AS_CLASS, AS_STRUCT, AS_UNION, AS_INTERFACE, AS_NAMESPACE;
static const string AS_END;
static const string AS_SELECTOR;
static const string AS_EXTERN, AS_ENUM;
static const string AS_STATIC, AS_CONST, AS_SEALED, AS_OVERRIDE, AS_VOLATILE, AS_NEW;
static const string AS_WHERE, AS_SYNCHRONIZED;
static const string AS_OPERATOR, AS_TEMPLATE;
static const string AS_OPEN_BRACKET, AS_CLOSE_BRACKET;
static const string AS_OPEN_LINE_COMMENT, AS_OPEN_COMMENT, AS_CLOSE_COMMENT;
static const string AS_BAR_DEFINE, AS_BAR_INCLUDE, AS_BAR_IF, AS_BAR_EL, AS_BAR_ENDIF;
static const string AS_RETURN;
static const string AS_CIN, AS_COUT, AS_CERR;
static const string AS_ASSIGN, AS_PLUS_ASSIGN, AS_MINUS_ASSIGN, AS_MULT_ASSIGN;
static const string AS_DIV_ASSIGN, AS_MOD_ASSIGN, AS_XOR_ASSIGN, AS_OR_ASSIGN, AS_AND_ASSIGN;
static const string AS_GR_GR_ASSIGN, AS_LS_LS_ASSIGN, AS_GR_GR_GR_ASSIGN, AS_LS_LS_LS_ASSIGN;
static const string AS_GCC_MIN_ASSIGN, AS_GCC_MAX_ASSIGN;
static const string AS_EQUAL, AS_PLUS_PLUS, AS_MINUS_MINUS, AS_NOT_EQUAL, AS_GR_EQUAL, AS_GR_GR_GR, AS_GR_GR;
static const string AS_LS_EQUAL, AS_LS_LS_LS, AS_LS_LS;
static const string AS_QUESTION_QUESTION, AS_LAMBDA;
static const string AS_ARROW, AS_AND, AS_OR;
static const string AS_SCOPE_RESOLUTION;
static const string AS_PLUS, AS_MINUS, AS_MULT, AS_DIV, AS_MOD, AS_GR, AS_LS;
static const string AS_NOT, AS_BIT_XOR, AS_BIT_OR, AS_BIT_AND, AS_BIT_NOT;
static const string AS_QUESTION, AS_COLON, AS_SEMICOLON, AS_COMMA;
static const string AS_ASM, AS__ASM__, AS_MS_ASM, AS_MS__ASM;
static const string AS_FOREACH, AS_LOCK, AS_UNSAFE, AS_FIXED;
static const string AS_GET, AS_SET, AS_ADD, AS_REMOVE;
static const string AS_DELEGATE, AS_UNCHECKED;
static const string AS_CONST_CAST, AS_DYNAMIC_CAST, AS_REINTERPRET_CAST, AS_STATIC_CAST;
static const string AS_NS_DURING, AS_NS_HANDLER;
}; // Class ASResource
//-----------------------------------------------------------------------------
// Class ASBase
//-----------------------------------------------------------------------------
class ASBase
{
private:
// all variables should be set by the "init" function
int baseFileType; // a value from enum FileType
protected:
ASBase() : baseFileType(C_TYPE) { }
virtual ~ASBase() {}
// functions definitions are at the end of ASResource.cpp
bool findKeyword(const string &line, int i, const string &keyword) const;
string getCurrentWord(const string &line, size_t index) const;
protected:
void init(int fileTypeArg) { baseFileType = fileTypeArg; }
bool isCStyle() const { return (baseFileType == C_TYPE); }
bool isJavaStyle() const { return (baseFileType == JAVA_TYPE); }
bool isSharpStyle() const { return (baseFileType == SHARP_TYPE); }
// check if a specific character is a digit
// NOTE: Visual C isdigit() gives assert error if char > 256
bool isDigit(char ch) const {
return (ch >= '0' && ch <= '9');
}
// check if a specific character can be used in a legal variable/method/class name
bool isLegalNameChar(char ch) const {
if (isWhiteSpace(ch)) return false;
if ((unsigned) ch > 127) return false;
return (isalnum((unsigned char)ch)
|| ch == '.' || ch == '_'
|| (isJavaStyle() && ch == '$')
|| (isSharpStyle() && ch == '@')); // may be used as a prefix
}
// check if a specific character can be part of a header
bool isCharPotentialHeader(const string &line, size_t i) const {
assert(!isWhiteSpace(line[i]));
char prevCh = ' ';
if (i > 0) prevCh = line[i - 1];
if (!isLegalNameChar(prevCh) && isLegalNameChar(line[i]))
return true;
return false;
}
// check if a specific character can be part of an operator
bool isCharPotentialOperator(char ch) const {
assert(!isWhiteSpace(ch));
if ((unsigned) ch > 127) return false;
return (ispunct((unsigned char)ch)
&& ch != '{' && ch != '}'
&& ch != '(' && ch != ')'
&& ch != '[' && ch != ']'
&& ch != ';' && ch != ','
&& ch != '#' && ch != '\\'
&& ch != '\'' && ch != '\"');
}
// check if a specific character is a whitespace character
bool isWhiteSpace(char ch) const { return (ch == ' ' || ch == '\t'); }
// peek at the next unread character.
char peekNextChar(const string &line, int i) const {
char ch = ' ';
size_t peekNum = line.find_first_not_of(" \t", i + 1);
if (peekNum == string::npos)
return ch;
ch = line[peekNum];
return ch;
}
}; // Class ASBase
//-----------------------------------------------------------------------------
// Class ASBeautifier
//-----------------------------------------------------------------------------
class ASBeautifier : protected ASResource, protected ASBase
{
public:
ASBeautifier();
virtual ~ASBeautifier();
virtual void init(ASSourceIterator* iter);
virtual string beautify(const string &line);
void setCaseIndent(bool state);
void setClassIndent(bool state);
void setCStyle();
void setDefaultTabLength();
void setEmptyLineFill(bool state);
void setForceTabXIndentation(int length);
void setJavaStyle();
void setLabelIndent(bool state);
void setMaxInStatementIndentLength(int max);
void setMinConditionalIndentOption(int min);
void setMinConditionalIndentLength();
void setModeManuallySet(bool state);
void setModifierIndent(bool state);
void setNamespaceIndent(bool state);
void setAlignMethodColon(bool state);
void setSharpStyle();
void setSpaceIndentation(int length = 4);
void setSwitchIndent(bool state);
void setTabIndentation(int length = 4, bool forceTabs = false);
void setPreprocDefineIndent(bool state);
void setPreprocConditionalIndent(bool state);
int getBeautifierFileType() const;
int getFileType() const;
int getIndentLength(void) const;
int getTabLength(void) const;
string getIndentString(void) const;
string getNextWord(const string &line, size_t currPos) const;
bool getBracketIndent(void) const;
bool getBlockIndent(void) const;
bool getCaseIndent(void) const;
bool getClassIndent(void) const;
bool getEmptyLineFill(void) const;
bool getForceTabIndentation(void) const;
bool getModeManuallySet(void) const;
bool getPreprocDefineIndent(void) const;
bool getSwitchIndent(void) const;
protected:
void deleteBeautifierVectors();
const string* findHeader(const string &line, int i,
const vector* possibleHeaders) const;
const string* findOperator(const string &line, int i,
const vector* possibleOperators) const;
int getNextProgramCharDistance(const string &line, int i) const;
int indexOf(vector &container, const string* element) const;
void setBlockIndent(bool state);
void setBracketIndent(bool state);
string trim(const string &str) const;
string rtrim(const string &str) const;
// variables set by ASFormatter - must be updated in activeBeautifierStack
int inLineNumber;
int horstmannIndentInStatement;
int nonInStatementBracket;
bool lineCommentNoBeautify;
bool isElseHeaderIndent;
bool isCaseHeaderCommentIndent;
bool isNonInStatementArray;
bool isSharpAccessor;
bool isSharpDelegate;
bool isInExternC;
bool isInBeautifySQL;
bool isInIndentableStruct;
private: // functions
ASBeautifier(const ASBeautifier ©);
ASBeautifier &operator=(ASBeautifier &); // not to be implemented
void adjustParsedLineIndentation(size_t iPrelim, bool isInExtraHeaderIndent);
void computePreliminaryIndentation();
void parseCurrentLine(const string &line);
void popLastInStatementIndent();
void processPreprocessor(const string &preproc, const string &line);
void registerInStatementIndent(const string &line, int i, int spaceIndentCount,
int tabIncrementIn, int minIndent, bool updateParenStack);
void initVectors();
void initTempStacksContainer(vector*>* &container,
vector*>* value);
void clearObjCMethodDefinitionAlignment();
void deleteBeautifierContainer(vector* &container);
void deleteTempStacksContainer(vector*>* &container);
int adjustIndentCountForBreakElseIfComments() const;
int computeObjCColonAlignment(string &line, int colonAlignPosition) const;
int convertTabToSpaces(int i, int tabIncrementIn) const;
int getInStatementIndentAssign(const string &line, size_t currPos) const;
int getInStatementIndentComma(const string &line, size_t currPos) const;
bool isIndentedPreprocessor(const string &line, size_t currPos) const;
bool isLineEndComment(const string &line, int startPos) const;
bool isPreprocessorConditionalCplusplus(const string &line) const;
bool isInPreprocessorUnterminatedComment(const string &line);
bool statementEndsWithComma(const string &line, int index) const;
string extractPreprocessorStatement(const string &line) const;
string preLineWS(int lineIndentCount, int lineSpaceIndentCount) const;
template void deleteContainer(T &container);
template void initContainer(T &container, T value);
vector*>* copyTempStacks(const ASBeautifier &other) const;
pair computePreprocessorIndent();
private: // variables
int beautifierFileType;
vector* headers;
vector* nonParenHeaders;
vector* preBlockStatements;
vector* preCommandHeaders;
vector* assignmentOperators;
vector* nonAssignmentOperators;
vector* indentableHeaders;
vector* waitingBeautifierStack;
vector* activeBeautifierStack;
vector* waitingBeautifierStackLengthStack;
vector* activeBeautifierStackLengthStack;
vector* headerStack;
vector< vector* >* tempStacks;
vector* blockParenDepthStack;
vector* blockStatementStack;
vector* parenStatementStack;
vector* bracketBlockStateStack;
vector* inStatementIndentStack;
vector* inStatementIndentStackSizeStack;
vector* parenIndentStack;
vector >* preprocIndentStack;
ASSourceIterator* sourceIterator;
const string* currentHeader;
const string* previousLastLineHeader;
const string* probationHeader;
const string* lastLineHeader;
string indentString;
string verbatimDelimiter;
bool isInQuote;
bool isInVerbatimQuote;
bool haveLineContinuationChar;
bool isInAsm;
bool isInAsmOneLine;
bool isInAsmBlock;
bool isInComment;
bool isInPreprocessorComment;
bool isInHorstmannComment;
bool isInCase;
bool isInQuestion;
bool isInStatement;
bool isInHeader;
bool isInTemplate;
bool isInDefine;
bool isInDefineDefinition;
bool classIndent;
bool isInClassInitializer;
bool isInClassHeaderTab;
bool isInObjCMethodDefinition;
bool isImmediatelyPostObjCMethodDefinition;
bool isInObjCInterface;
bool isInEnum;
bool modifierIndent;
bool switchIndent;
bool caseIndent;
bool namespaceIndent;
bool bracketIndent;
bool blockIndent;
bool labelIndent;
bool shouldIndentPreprocDefine;
bool isInConditional;
bool isModeManuallySet;
bool shouldForceTabIndentation;
bool emptyLineFill;
bool backslashEndsPrevLine;
bool lineOpensWithLineComment;
bool lineOpensWithComment;
bool lineStartsInComment;
bool blockCommentNoIndent;
bool blockCommentNoBeautify;
bool previousLineProbationTab;
bool lineBeginsWithOpenBracket;
bool lineBeginsWithCloseBracket;
bool shouldIndentBrackettedLine;
bool isInClass;
bool isInSwitch;
bool foundPreCommandHeader;
bool foundPreCommandMacro;
bool shouldAlignMethodColon;
bool shouldIndentPreprocConditional;
int indentCount;
int spaceIndentCount;
int spaceIndentObjCMethodDefinition;
int colonIndentObjCMethodDefinition;
int lineOpeningBlocksNum;
int lineClosingBlocksNum;
int fileType;
int minConditionalOption;
int minConditionalIndent;
int parenDepth;
int indentLength;
int tabLength;
int blockTabCount;
int maxInStatementIndent;
int classInitializerIndents;
int templateDepth;
int squareBracketCount;
int prevFinalLineSpaceIndentCount;
int prevFinalLineIndentCount;
int defineIndentCount;
char quoteChar;
char prevNonSpaceCh;
char currentNonSpaceCh;
char currentNonLegalCh;
char prevNonLegalCh;
}; // Class ASBeautifier
//-----------------------------------------------------------------------------
// Class ASEnhancer
//-----------------------------------------------------------------------------
class ASEnhancer : protected ASBase
{
public: // functions
ASEnhancer();
virtual ~ASEnhancer();
void init(int, int, int, bool, bool, bool, bool, bool);
void enhance(string &line, bool isInPreprocessor, bool isInSQL);
private: // functions
void convertForceTabIndentToSpaces(string &line) const;
void convertSpaceIndentToForceTab(string &line) const;
size_t findCaseColon(string &line, size_t caseIndex) const;
int indentLine(string &line, int indent) const;
bool isBeginDeclareSectionSQL(string &line, size_t index) const;
bool isEndDeclareSectionSQL(string &line, size_t index) const;
bool isOneLineBlockReached(string &line, int startChar) const;
void parseCurrentLine(string &line, bool isInPreprocessor, bool isInSQL);
size_t processSwitchBlock(string &line, size_t index);
int unindentLine(string &line, int unindent) const;
private:
// options from command line or options file
int indentLength;
int tabLength;
bool useTabs;
bool forceTab;
bool caseIndent;
bool preprocessorIndent;
bool emptyLineFill;
// parsing variables
int lineNumber;
bool isInQuote;
bool isInComment;
char quoteChar;
// unindent variables
int bracketCount;
int switchDepth;
bool lookingForCaseBracket;
bool unindentNextLine;
bool shouldUnindentLine;
bool shouldUnindentComment;
// struct used by ParseFormattedLine function
// contains variables used to unindent the case blocks
struct switchVariables
{
int switchBracketCount;
int unindentDepth;
bool unindentCase;
};
switchVariables sw; // switch variables struct
vector switchStack; // stack vector of switch variables
// event table variables
bool nextLineIsEventIndent; // begin event table indent is reached
bool isInEventTable; // need to indent an event table
// SQL variables
bool nextLineIsDeclareIndent; // begin declare section indent is reached
bool isInDeclareSection; // need to indent a declare section
}; // Class ASEnhancer
//-----------------------------------------------------------------------------
// Class ASFormatter
//-----------------------------------------------------------------------------
class ASFormatter : public ASBeautifier
{
public: // functions
ASFormatter();
virtual ~ASFormatter();
virtual void init(ASSourceIterator* iter);
virtual bool hasMoreLines() const;
virtual string nextLine();
LineEndFormat getLineEndFormat() const;
bool getIsLineReady() const;
void setFormattingStyle(FormatStyle style);
void setAddBracketsMode(bool state);
void setAddOneLineBracketsMode(bool state);
void setRemoveBracketsMode(bool state);
void setAttachClass(bool state);
void setAttachExternC(bool state);
void setAttachNamespace(bool state);
void setAttachInline(bool state);
void setBracketFormatMode(BracketMode mode);
void setBreakAfterMode(bool state);
void setBreakClosingHeaderBracketsMode(bool state);
void setBreakBlocksMode(bool state);
void setBreakClosingHeaderBlocksMode(bool state);
void setBreakElseIfsMode(bool state);
void setBreakOneLineBlocksMode(bool state);
void setMethodPrefixPaddingMode(bool state);
void setMethodPrefixUnPaddingMode(bool state);
void setCloseTemplatesMode(bool state);
void setDeleteEmptyLinesMode(bool state);
void setIndentCol1CommentsMode(bool state);
void setLineEndFormat(LineEndFormat fmt);
void setMaxCodeLength(int max);
void setObjCColonPaddingMode(ObjCColonPad mode);
void setOperatorPaddingMode(bool mode);
void setParensOutsidePaddingMode(bool mode);
void setParensFirstPaddingMode(bool mode);
void setParensInsidePaddingMode(bool mode);
void setParensHeaderPaddingMode(bool mode);
void setParensUnPaddingMode(bool state);
void setPointerAlignment(PointerAlign alignment);
void setReferenceAlignment(ReferenceAlign alignment);
void setSingleStatementsMode(bool state);
void setStripCommentPrefix(bool state);
void setTabSpaceConversionMode(bool state);
size_t getChecksumIn() const;
size_t getChecksumOut() const;
int getChecksumDiff() const;
int getFormatterFileType() const;
private: // functions
ASFormatter(const ASFormatter ©); // copy constructor not to be implemented
ASFormatter &operator=(ASFormatter &); // assignment operator not to be implemented
template void deleteContainer(T &container);
template void initContainer(T &container, T value);
char peekNextChar() const;
BracketType getBracketType();
bool addBracketsToStatement();
bool removeBracketsFromStatement();
bool commentAndHeaderFollows();
bool getNextChar();
bool getNextLine(bool emptyLineWasDeleted = false);
bool isArrayOperator() const;
bool isBeforeComment() const;
bool isBeforeAnyComment() const;
bool isBeforeAnyLineEndComment(int startPos) const;
bool isBeforeMultipleLineEndComments(int startPos) const;
bool isBracketType(BracketType a, BracketType b) const;
bool isClosingHeader(const string* header) const;
bool isCurrentBracketBroken() const;
bool isDereferenceOrAddressOf() const;
bool isExecSQL(string &line, size_t index) const;
bool isEmptyLine(const string &line) const;
bool isExternC() const;
bool isNextWordSharpNonParenHeader(int startChar) const;
bool isNonInStatementArrayBracket() const;
bool isOkToSplitFormattedLine();
bool isPointerOrReference() const;
bool isPointerOrReferenceCentered() const;
bool isPointerOrReferenceVariable(string &word) const;
bool isSharpStyleWithParen(const string* header) const;
bool isStructAccessModified(string &firstLine, size_t index) const;
bool isUnaryOperator() const;
bool isImmediatelyPostCast() const;
bool isInExponent() const;
bool isInSwitchStatement() const;
bool isNextCharOpeningBracket(int startChar) const;
bool isOkToBreakBlock(BracketType bracketType) const;
bool pointerSymbolFollows() const;
int getCurrentLineCommentAdjustment();
int getNextLineCommentAdjustment();
int isOneLineBlockReached(string &line, int startChar) const;
void adjustComments();
void appendChar(char ch, bool canBreakLine);
void appendCharInsideComments();
void appendOperator(const string &sequence, bool canBreakLine = true);
void appendSequence(const string &sequence, bool canBreakLine = true);
void appendSpacePad();
void appendSpaceAfter();
void breakLine(bool isSplitLine = false);
void buildLanguageVectors();
void updateFormattedLineSplitPoints(char appendedChar);
void updateFormattedLineSplitPointsOperator(const string &sequence);
void checkIfTemplateOpener();
void clearFormattedLineSplitPoints();
void convertTabToSpaces();
void deleteContainer(vector* &container);
void formatArrayRunIn();
void formatRunIn();
void formatArrayBrackets(BracketType bracketType, bool isOpeningArrayBracket);
void formatClosingBracket(BracketType bracketType);
void formatCommentBody();
void formatCommentOpener();
void formatCommentCloser();
void formatLineCommentBody();
void formatLineCommentOpener();
void formatOpeningBracket(BracketType bracketType);
void formatQuoteBody();
void formatQuoteOpener();
void formatPointerOrReference();
void formatPointerOrReferenceCast();
void formatPointerOrReferenceToMiddle();
void formatPointerOrReferenceToName();
void formatPointerOrReferenceToType();
void fixOptionVariableConflicts();
void goForward(int i);
void isLineBreakBeforeClosingHeader();
void initContainer(vector* &container, vector* value);
void initNewLine();
void padObjCMethodColon();
void padOperators(const string* newOperator);
void padParens();
void processPreprocessor();
void resetEndOfStatement();
void setAttachClosingBracket(bool state);
void setBreakBlocksVariables();
void stripCommentPrefix();
void testForTimeToSplitFormattedLine();
void trimContinuationLine();
void updateFormattedLineSplitPointsPointerOrReference(size_t index);
size_t findFormattedLineSplitPoint() const;
size_t findNextChar(string &line, char searchChar, int searchStart = 0);
const string* checkForHeaderFollowingComment(const string &firstLine) const;
const string* getFollowingOperator() const;
string getPreviousWord(const string &line, int currPos) const;
string peekNextText(const string &firstLine, bool endOnEmptyLine = false, bool shouldReset = false) const;
private: // variables
int formatterFileType;
vector* headers;
vector* nonParenHeaders;
vector* preDefinitionHeaders;
vector* preCommandHeaders;
vector* operators;
vector* assignmentOperators;
vector* castOperators;
ASSourceIterator* sourceIterator;
ASEnhancer* enhancer;
vector* preBracketHeaderStack;
vector* bracketTypeStack;
vector* parenStack;
vector* structStack;
vector* questionMarkStack;
string readyFormattedLine;
string currentLine;
string formattedLine;
const string* currentHeader;
const string* previousOperator; // used ONLY by pad-oper
char currentChar;
char previousChar;
char previousNonWSChar;
char previousCommandChar;
char quoteChar;
int charNum;
int horstmannIndentChars;
int nextLineSpacePadNum;
int preprocBracketTypeStackSize;
int spacePadNum;
int tabIncrementIn;
int templateDepth;
int traceLineNumber;
int squareBracketCount;
size_t checksumIn;
size_t checksumOut;
size_t currentLineFirstBracketNum; // first bracket location on currentLine
size_t formattedLineCommentNum; // comment location on formattedLine
size_t leadingSpaces;
size_t maxCodeLength;
// possible split points
size_t maxSemi; // probably a 'for' statement
size_t maxAndOr; // probably an 'if' statement
size_t maxComma;
size_t maxParen;
size_t maxWhiteSpace;
size_t maxSemiPending;
size_t maxAndOrPending;
size_t maxCommaPending;
size_t maxParenPending;
size_t maxWhiteSpacePending;
size_t previousReadyFormattedLineLength;
FormatStyle formattingStyle;
BracketMode bracketFormatMode;
BracketType previousBracketType;
PointerAlign pointerAlignment;
ReferenceAlign referenceAlignment;
ObjCColonPad objCColonPadMode;
LineEndFormat lineEnd;
bool adjustChecksumIn(int adjustment);
bool computeChecksumIn(const string ¤tLine_);
bool computeChecksumOut(const string &beautifiedLine);
bool isVirgin;
bool shouldPadOperators;
bool shouldPadParensOutside;
bool shouldPadFirstParen;
bool shouldPadParensInside;
bool shouldPadHeader;
bool shouldStripCommentPrefix;
bool shouldUnPadParens;
bool shouldConvertTabs;
bool shouldIndentCol1Comments;
bool shouldCloseTemplates;
bool shouldAttachExternC;
bool shouldAttachNamespace;
bool shouldAttachClass;
bool shouldAttachInline;
bool isInLineComment;
bool isInComment;
bool isInCommentStartLine;
bool noTrimCommentContinuation;
bool isInPreprocessor;
bool isInPreprocessorBeautify;
bool isInTemplate;
bool doesLineStartComment;
bool lineEndsInCommentOnly;
bool lineIsLineCommentOnly;
bool lineIsEmpty;
bool isImmediatelyPostCommentOnly;
bool isImmediatelyPostEmptyLine;
bool isInQuote;
bool isInVerbatimQuote;
bool haveLineContinuationChar;
bool isInQuoteContinuation;
bool isHeaderInMultiStatementLine;
bool isSpecialChar;
bool isNonParenHeader;
bool foundQuestionMark;
bool foundPreDefinitionHeader;
bool foundNamespaceHeader;
bool foundClassHeader;
bool foundStructHeader;
bool foundInterfaceHeader;
bool foundPreCommandHeader;
bool foundPreCommandMacro;
bool foundCastOperator;
bool isInLineBreak;
bool endOfAsmReached;
bool endOfCodeReached;
bool lineCommentNoIndent;
bool isInEnum;
bool isInExecSQL;
bool isInAsm;
bool isInAsmOneLine;
bool isInAsmBlock;
bool isLineReady;
bool elseHeaderFollowsComments;
bool caseHeaderFollowsComments;
bool isPreviousBracketBlockRelated;
bool isInPotentialCalculation;
bool isCharImmediatelyPostComment;
bool isPreviousCharPostComment;
bool isCharImmediatelyPostLineComment;
bool isCharImmediatelyPostOpenBlock;
bool isCharImmediatelyPostCloseBlock;
bool isCharImmediatelyPostTemplate;
bool isCharImmediatelyPostReturn;
bool isCharImmediatelyPostThrow;
bool isCharImmediatelyPostOperator;
bool isCharImmediatelyPostPointerOrReference;
bool isInObjCMethodDefinition;
bool isInObjCInterface;
bool isInObjCSelector;
bool breakCurrentOneLineBlock;
bool shouldRemoveNextClosingBracket;
bool isInHorstmannRunIn;
bool currentLineBeginsWithBracket;
bool shouldAttachClosingBracket;
bool shouldBreakOneLineBlocks;
bool shouldReparseCurrentChar;
bool shouldBreakOneLineStatements;
bool shouldBreakClosingHeaderBrackets;
bool shouldBreakElseIfs;
bool shouldBreakLineAfterLogical;
bool shouldAddBrackets;
bool shouldAddOneLineBrackets;
bool shouldRemoveBrackets;
bool shouldPadMethodColon;
bool shouldPadMethodPrefix;
bool shouldUnPadMethodPrefix;
bool shouldDeleteEmptyLines;
bool needHeaderOpeningBracket;
bool shouldBreakLineAtNextChar;
bool shouldKeepLineUnbroken;
bool passedSemicolon;
bool passedColon;
bool isImmediatelyPostNonInStmt;
bool isCharImmediatelyPostNonInStmt;
bool isImmediatelyPostComment;
bool isImmediatelyPostLineComment;
bool isImmediatelyPostEmptyBlock;
bool isImmediatelyPostPreprocessor;
bool isImmediatelyPostReturn;
bool isImmediatelyPostThrow;
bool isImmediatelyPostOperator;
bool isImmediatelyPostTemplate;
bool isImmediatelyPostPointerOrReference;
bool shouldBreakBlocks;
bool shouldBreakClosingHeaderBlocks;
bool isPrependPostBlockEmptyLineRequested;
bool isAppendPostBlockEmptyLineRequested;
bool prependEmptyLine;
bool appendOpeningBracket;
bool foundClosingHeader;
bool isInHeader;
bool isImmediatelyPostHeader;
bool isInCase;
bool isJavaStaticConstructor;
private: // inline functions
// append the CURRENT character (curentChar) to the current formatted line.
void appendCurrentChar(bool canBreakLine = true) {
appendChar(currentChar, canBreakLine);
}
// check if a specific sequence exists in the current placement of the current line
bool isSequenceReached(const char* sequence) const {
return currentLine.compare(charNum, strlen(sequence), sequence) == 0;
}
// call ASBase::findHeader for the current character
const string* findHeader(const vector* headers_) {
return ASBeautifier::findHeader(currentLine, charNum, headers_);
}
// call ASBase::findOperator for the current character
const string* findOperator(const vector* headers_) {
return ASBeautifier::findOperator(currentLine, charNum, headers_);
}
}; // Class ASFormatter
//-----------------------------------------------------------------------------
// astyle namespace global declarations
//-----------------------------------------------------------------------------
// sort comparison functions for ASResource
bool sortOnLength(const string* a, const string* b);
bool sortOnName(const string* a, const string* b);
} // end of astyle namespace
// end of astyle namespace --------------------------------------------------
//-----------------------------------------------------------------------------
// declarations for library build
// global because they are called externally and are NOT part of the namespace
//-----------------------------------------------------------------------------
typedef void (STDCALL* fpError)(int, const char*); // pointer to callback error handler
typedef char* (STDCALL* fpAlloc)(unsigned long); // pointer to callback memory allocation
extern "C" EXPORT char* STDCALL AStyleMain(const char*, const char*, fpError, fpAlloc);
extern "C" EXPORT const char* STDCALL AStyleGetVersion (void);
#endif // closes ASTYLE_H
astyle/src/astyle_main.cpp 100777 0 0 324071 12235007664 11352 0 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* astyle_main.cpp
*
* Copyright (C) 2006-2013 by Jim Pattee
* Copyright (C) 1998-2002 by Tal Davidson
*
*
* This file is a part of Artistic Style - an indentation and
* reformatting tool for C, C++, C# and Java source files.
*
*
* Artistic Style is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Artistic Style is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Artistic Style. If not, see .
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*/
#include "astyle_main.h"
#include
#include
#include
#include
#include
// includes for recursive getFileNames() function
#ifdef _WIN32
#undef UNICODE // use ASCII windows functions
#include
#else
#include
#include
#include
#ifdef __VMS
#include
#include
#include
#include
#include
#include
#endif /* __VMS */
#endif
#ifdef __DMC__
#include
#endif
// turn off MinGW automatic file globbing
// this CANNOT be in the astyle namespace
#ifndef ASTYLE_LIB
int _CRT_glob = 0;
#endif
namespace astyle {
#ifdef _WIN32
char g_fileSeparator = '\\';
bool g_isCaseSensitive = false;
#else
char g_fileSeparator = '/';
bool g_isCaseSensitive = true;
#endif
// console build variables
#ifndef ASTYLE_LIB
ostream* _err = &cerr; // direct error messages to cerr
ASConsole* g_console = NULL; // class to encapsulate console variables
#endif
#ifdef ASTYLE_JNI
// java library build variables
JNIEnv* g_env;
jobject g_obj;
jmethodID g_mid;
#endif
const char* g_version = "2.04";
//-----------------------------------------------------------------------------
// ASStreamIterator class
// typename will be istringstream for GUI and istream otherwise
//-----------------------------------------------------------------------------
template
ASStreamIterator::ASStreamIterator(T* in)
{
inStream = in;
buffer.reserve(200);
eolWindows = 0;
eolLinux = 0;
eolMacOld = 0;
outputEOL[0] = '\0';
peekStart = 0;
prevLineDeleted = false;
checkForEmptyLine = false;
}
template
ASStreamIterator::~ASStreamIterator()
{
}
/**
* read the input stream, delete any end of line characters,
* and build a string that contains the input line.
*
* @return string containing the next input line minus any end of line characters
*/
template
string ASStreamIterator::nextLine(bool emptyLineWasDeleted)
{
// verify that the current position is correct
assert (peekStart == 0);
// a deleted line may be replaced if break-blocks is requested
// this sets up the compare to check for a replaced empty line
if (prevLineDeleted)
{
prevLineDeleted = false;
checkForEmptyLine = true;
}
if (!emptyLineWasDeleted)
prevBuffer = buffer;
else
prevLineDeleted = true;
// read the next record
buffer.clear();
char ch;
inStream->get(ch);
while (!inStream->eof() && ch != '\n' && ch != '\r')
{
buffer.append(1, ch);
inStream->get(ch);
}
if (inStream->eof())
{
return buffer;
}
int peekCh = inStream->peek();
// find input end-of-line characters
if (!inStream->eof())
{
if (ch == '\r') // CR+LF is windows otherwise Mac OS 9
{
if (peekCh == '\n')
{
inStream->get();
eolWindows++;
}
else
eolMacOld++;
}
else // LF is Linux, allow for improbable LF/CR
{
if (peekCh == '\r')
{
inStream->get();
eolWindows++;
}
else
eolLinux++;
}
}
else
{
inStream->clear();
}
// set output end of line characters
if (eolWindows >= eolLinux)
{
if (eolWindows >= eolMacOld)
strcpy(outputEOL, "\r\n"); // Windows (CR+LF)
else
strcpy(outputEOL, "\r"); // MacOld (CR)
}
else if (eolLinux >= eolMacOld)
strcpy(outputEOL, "\n"); // Linux (LF)
else
strcpy(outputEOL, "\r"); // MacOld (CR)
return buffer;
}
// save the current position and get the next line
// this can be called for multiple reads
// when finished peeking you MUST call peekReset()
// call this function from ASFormatter ONLY
template
string ASStreamIterator::peekNextLine()
{
assert (hasMoreLines());
string nextLine_;
char ch;
if (peekStart == 0)
peekStart = inStream->tellg();
// read the next record
inStream->get(ch);
while (!inStream->eof() && ch != '\n' && ch != '\r')
{
nextLine_.append(1, ch);
inStream->get(ch);
}
if (inStream->eof())
{
return nextLine_;
}
int peekCh = inStream->peek();
// remove end-of-line characters
if (!inStream->eof())
{
if ((peekCh == '\n' || peekCh == '\r') && peekCh != ch)
inStream->get();
}
return nextLine_;
}
// reset current position and EOF for peekNextLine()
template
void ASStreamIterator::peekReset()
{
assert(peekStart != 0);
inStream->clear();
inStream->seekg(peekStart);
peekStart = 0;
}
// save the last input line after input has reached EOF
template
void ASStreamIterator::saveLastInputLine()
{
assert(inStream->eof());
prevBuffer = buffer;
}
// check for a change in line ends
template
bool ASStreamIterator::getLineEndChange(int lineEndFormat) const
{
assert(lineEndFormat == LINEEND_DEFAULT
|| lineEndFormat == LINEEND_WINDOWS
|| lineEndFormat == LINEEND_LINUX
|| lineEndFormat == LINEEND_MACOLD);
bool lineEndChange = false;
if (lineEndFormat == LINEEND_WINDOWS)
lineEndChange = (eolLinux + eolMacOld != 0);
else if (lineEndFormat == LINEEND_LINUX)
lineEndChange = (eolWindows + eolMacOld != 0);
else if (lineEndFormat == LINEEND_MACOLD)
lineEndChange = (eolWindows + eolLinux != 0);
else
{
if (eolWindows > 0)
lineEndChange = (eolLinux + eolMacOld != 0);
else if (eolLinux > 0)
lineEndChange = (eolWindows + eolMacOld != 0);
else if (eolMacOld > 0)
lineEndChange = (eolWindows + eolLinux != 0);
}
return lineEndChange;
}
//-----------------------------------------------------------------------------
// ASConsole class
// main function will be included only in the console build
//-----------------------------------------------------------------------------
#ifndef ASTYLE_LIB
// rewrite a stringstream converting the line ends
void ASConsole::convertLineEnds(ostringstream &out, int lineEnd)
{
assert(lineEnd == LINEEND_WINDOWS || lineEnd == LINEEND_LINUX || lineEnd == LINEEND_MACOLD);
const string &inStr = out.str(); // avoids strange looking syntax
string outStr; // the converted ouput
int inLength = inStr.length();
for (int pos = 0; pos < inLength; pos++)
{
if (inStr[pos] == '\r')
{
if (inStr[pos + 1] == '\n')
{
// CRLF
if (lineEnd == LINEEND_CR)
{
outStr += inStr[pos]; // Delete the LF
pos++;
continue;
}
else if (lineEnd == LINEEND_LF)
{
outStr += inStr[pos + 1]; // Delete the CR
pos++;
continue;
}
else
{
outStr += inStr[pos]; // Do not change
outStr += inStr[pos + 1];
pos++;
continue;
}
}
else
{
// CR
if (lineEnd == LINEEND_CRLF)
{
outStr += inStr[pos]; // Insert the CR
outStr += '\n'; // Insert the LF
continue;
}
else if (lineEnd == LINEEND_LF)
{
outStr += '\n'; // Insert the LF
continue;
}
else
{
outStr += inStr[pos]; // Do not change
continue;
}
}
}
else if (inStr[pos] == '\n')
{
// LF
if (lineEnd == LINEEND_CRLF)
{
outStr += '\r'; // Insert the CR
outStr += inStr[pos]; // Insert the LF
continue;
}
else if (lineEnd == LINEEND_CR)
{
outStr += '\r'; // Insert the CR
continue;
}
else
{
outStr += inStr[pos]; // Do not change
continue;
}
}
else
{
outStr += inStr[pos]; // Write the current char
}
}
// replace the stream
out.str(outStr);
}
void ASConsole::correctMixedLineEnds(ostringstream &out)
{
LineEndFormat lineEndFormat = LINEEND_DEFAULT;
if (strcmp(outputEOL, "\r\n") == 0)
lineEndFormat = LINEEND_WINDOWS;
if (strcmp(outputEOL, "\n") == 0)
lineEndFormat = LINEEND_LINUX;
if (strcmp(outputEOL, "\r") == 0)
lineEndFormat = LINEEND_MACOLD;
convertLineEnds(out, lineEndFormat);
}
// check files for 16 or 32 bit encoding
// the file must have a Byte Order Mark (BOM)
// NOTE: some string functions don't work with NULLs (e.g. length())
FileEncoding ASConsole::detectEncoding(const char* data, size_t dataSize) const
{
FileEncoding encoding = ENCODING_8BIT;
if (dataSize >= 4 && memcmp(data, "\x00\x00\xFE\xFF", 4) == 0)
encoding = UTF_32BE;
else if (dataSize >= 4 && memcmp(data, "\xFF\xFE\x00\x00", 4) == 0)
encoding = UTF_32LE;
else if (dataSize >= 2 && memcmp(data, "\xFE\xFF", 2) == 0)
encoding = UTF_16BE;
else if (dataSize >= 2 && memcmp(data, "\xFF\xFE", 2) == 0)
encoding = UTF_16LE;
return encoding;
}
// error exit without a message
void ASConsole::error() const
{
(*_err) << _("\nArtistic Style has terminated") << endl;
exit(EXIT_FAILURE);
}
// error exit with a message
void ASConsole::error(const char* why, const char* what) const
{
(*_err) << why << ' ' << what << endl;
error();
}
/**
* If no files have been given, use cin for input and cout for output.
*
* This is used to format text for text editors like TextWrangler (Mac).
* Do NOT display any console messages when this function is used.
*/
void ASConsole::formatCinToCout()
{
// Using cin.tellg() causes problems with both Windows and Linux.
// The Windows problem occurs when the input is not Windows line-ends.
// The tellg() will be out of sequence with the get() statements.
// The Linux cin.tellg() will return -1 (invalid).
// Copying the input sequentially to a stringstream before
// formatting solves the problem for both.
istream* inStream = &cin;
stringstream outStream;
char ch;
while (!inStream->eof())
{
inStream->get(ch);
outStream.put(ch);
}
ASStreamIterator streamIterator(&outStream);
// Windows pipe or redirection always outputs Windows line-ends.
// Linux pipe or redirection will output any line end.
LineEndFormat lineEndFormat = formatter.getLineEndFormat();
initializeOutputEOL(lineEndFormat);
formatter.init(&streamIterator);
while (formatter.hasMoreLines())
{
cout << formatter.nextLine();
if (formatter.hasMoreLines())
{
setOutputEOL(lineEndFormat, streamIterator.getOutputEOL());
cout << outputEOL;
}
else
{
// this can happen if the file if missing a closing bracket and break-blocks is requested
if (formatter.getIsLineReady())
{
setOutputEOL(lineEndFormat, streamIterator.getOutputEOL());
cout << outputEOL;
cout << formatter.nextLine();
}
}
}
cout.flush();
}
/**
* Open input file, format it, and close the output.
*
* @param fileName_ The path and name of the file to be processed.
*/
void ASConsole::formatFile(const string &fileName_)
{
stringstream in;
ostringstream out;
FileEncoding encoding = readFile(fileName_, in);
// Unless a specific language mode has been set, set the language mode
// according to the file's suffix.
if (!formatter.getModeManuallySet())
{
if (stringEndsWith(fileName_, string(".java")))
formatter.setJavaStyle();
else if (stringEndsWith(fileName_, string(".cs")))
formatter.setSharpStyle();
else
formatter.setCStyle();
}
// set line end format
string nextLine; // next output line
filesAreIdentical = true; // input and output files are identical
LineEndFormat lineEndFormat = formatter.getLineEndFormat();
initializeOutputEOL(lineEndFormat);
// do this AFTER setting the file mode
ASStreamIterator streamIterator(&in);
formatter.init(&streamIterator);
// format the file
while (formatter.hasMoreLines())
{
nextLine = formatter.nextLine();
out << nextLine;
linesOut++;
if (formatter.hasMoreLines())
{
setOutputEOL(lineEndFormat, streamIterator.getOutputEOL());
out << outputEOL;
}
else
{
streamIterator.saveLastInputLine(); // to compare the last input line
// this can happen if the file if missing a closing bracket and break-blocks is requested
if (formatter.getIsLineReady())
{
setOutputEOL(lineEndFormat, streamIterator.getOutputEOL());
out << outputEOL;
nextLine = formatter.nextLine();
out << nextLine;
linesOut++;
streamIterator.saveLastInputLine();
}
}
if (filesAreIdentical)
{
if (streamIterator.checkForEmptyLine)
{
if (nextLine.find_first_not_of(" \t") != string::npos)
filesAreIdentical = false;
}
else if (!streamIterator.compareToInputBuffer(nextLine))
filesAreIdentical = false;
streamIterator.checkForEmptyLine = false;
}
}
// correct for mixed line ends
if (lineEndsMixed)
{
correctMixedLineEnds(out);
filesAreIdentical = false;
}
// remove targetDirectory from filename if required by print
string displayName;
if (hasWildcard)
displayName = fileName_.substr(targetDirectory.length() + 1);
else
displayName = fileName_;
// if file has changed, write the new file
if (!filesAreIdentical || streamIterator.getLineEndChange(lineEndFormat))
{
writeFile(fileName_, encoding, out);
printMsg(_("Formatted %s\n"), displayName);
filesFormatted++;
}
else
{
if (!isFormattedOnly)
printMsg(_("Unchanged %s\n"), displayName);
filesUnchanged++;
}
assert(formatter.getChecksumDiff() == 0);
}
// build a vector of argv options
// the program path argv[0] is excluded
vector ASConsole::getArgvOptions(int argc, char** argv) const
{
vector argvOptions;
for (int i = 1; i < argc; i++)
{
argvOptions.push_back(string(argv[i]));
}
return argvOptions;
}
// for unit testing
vector ASConsole::getExcludeHitsVector()
{ return excludeHitsVector; }
// for unit testing
vector ASConsole::getExcludeVector()
{ return excludeVector; }
// for unit testing
vector ASConsole::getFileName()
{ return fileName; }
// for unit testing
vector ASConsole::getFileNameVector()
{ return fileNameVector; }
// for unit testing
vector ASConsole::getFileOptionsVector()
{ return fileOptionsVector; }
// for unit testing
int ASConsole::getFilesFormatted()
{ return filesFormatted; }
// for unit testing
bool ASConsole::getIgnoreExcludeErrors()
{ return ignoreExcludeErrors; }
// for unit testing
bool ASConsole::getIgnoreExcludeErrorsDisplay()
{ return ignoreExcludeErrorsDisplay; }
// for unit testing
bool ASConsole::getIsFormattedOnly()
{ return isFormattedOnly; }
// for unit testing
string ASConsole::getLanguageID() const
{ return localizer.getLanguageID(); }
// for unit testing
bool ASConsole::getIsQuiet()
{ return isQuiet; }
// for unit testing
bool ASConsole::getIsRecursive()
{ return isRecursive; }
// for unit testing
bool ASConsole::getIsVerbose()
{ return isVerbose; }
// for unit testing
bool ASConsole::getLineEndsMixed()
{ return lineEndsMixed; }
// for unit testing
bool ASConsole::getNoBackup()
{ return noBackup; }
// for unit testing
string ASConsole::getOptionsFileName()
{ return optionsFileName; }
// for unit testing
vector ASConsole::getOptionsVector()
{ return optionsVector; }
// for unit testing
string ASConsole::getOrigSuffix()
{ return origSuffix; }
// for unit testing
bool ASConsole::getPreserveDate()
{ return preserveDate; }
string ASConsole::getParam(const string &arg, const char* op)
{
return arg.substr(strlen(op));
}
// initialize output end of line
void ASConsole::initializeOutputEOL(LineEndFormat lineEndFormat)
{
assert(lineEndFormat == LINEEND_DEFAULT
|| lineEndFormat == LINEEND_WINDOWS
|| lineEndFormat == LINEEND_LINUX
|| lineEndFormat == LINEEND_MACOLD);
outputEOL[0] = '\0'; // current line end
prevEOL[0] = '\0'; // previous line end
lineEndsMixed = false; // output has mixed line ends, LINEEND_DEFAULT only
if (lineEndFormat == LINEEND_WINDOWS)
strcpy(outputEOL, "\r\n");
else if (lineEndFormat == LINEEND_LINUX)
strcpy(outputEOL, "\n");
else if (lineEndFormat == LINEEND_MACOLD)
strcpy(outputEOL, "\r");
else
outputEOL[0] = '\0';
}
FileEncoding ASConsole::readFile(const string &fileName_, stringstream &in) const
{
const int blockSize = 65536; // 64 KB
ifstream fin(fileName_.c_str(), ios::binary);
if (!fin)
error("Cannot open input file", fileName_.c_str());
char* data = new(nothrow) char[blockSize];
if (!data)
error("Cannot allocate memory for input file", fileName_.c_str());
fin.read(data, sizeof(data));
if (fin.bad())
error("Cannot read input file", fileName_.c_str());
size_t dataSize = static_cast(fin.gcount());
FileEncoding encoding = detectEncoding(data, dataSize);
if (encoding == UTF_32BE || encoding == UTF_32LE)
error(_("Cannot process UTF-32 encoding"), fileName_.c_str());
bool firstBlock = true;
while (dataSize)
{
if (encoding == UTF_16LE || encoding == UTF_16BE)
{
// convert utf-16 to utf-8
size_t utf8Size = Utf8LengthFromUtf16(data, dataSize, encoding);
char* utf8Out = new(nothrow) char[utf8Size];
if (!utf8Out)
error("Cannot allocate memory for utf-8 conversion", fileName_.c_str());
size_t utf8Len = Utf16ToUtf8(data, dataSize, encoding, firstBlock, utf8Out);
assert(utf8Len == utf8Size);
in << string(utf8Out, utf8Len);
delete []utf8Out;
}
else
in << string(data, dataSize);
fin.read(data, sizeof(data));
if (fin.bad())
error("Cannot read input file", fileName_.c_str());
dataSize = static_cast(fin.gcount());
firstBlock = false;
}
fin.close();
delete [] data;
return encoding;
}
void ASConsole::setIgnoreExcludeErrors(bool state)
{ ignoreExcludeErrors = state; }
void ASConsole::setIgnoreExcludeErrorsAndDisplay(bool state)
{ ignoreExcludeErrors = state; ignoreExcludeErrorsDisplay = state; }
void ASConsole::setIsFormattedOnly(bool state)
{ isFormattedOnly = state; }
void ASConsole::setIsQuiet(bool state)
{ isQuiet = state; }
void ASConsole::setIsRecursive(bool state)
{ isRecursive = state; }
void ASConsole::setIsVerbose(bool state)
{ isVerbose = state; }
void ASConsole::setNoBackup(bool state)
{ noBackup = state; }
void ASConsole::setOptionsFileName(string name)
{ optionsFileName = name; }
void ASConsole::setOrigSuffix(string suffix)
{ origSuffix = suffix; }
void ASConsole::setPreserveDate(bool state)
{ preserveDate = state; }
// set outputEOL variable
void ASConsole::setOutputEOL(LineEndFormat lineEndFormat, const char* currentEOL)
{
if (lineEndFormat == LINEEND_DEFAULT)
{
strcpy(outputEOL, currentEOL);
if (strlen(prevEOL) == 0)
strcpy(prevEOL, outputEOL);
if (strcmp(prevEOL, outputEOL) != 0)
{
lineEndsMixed = true;
filesAreIdentical = false;
strcpy(prevEOL, outputEOL);
}
}
else
{
strcpy(prevEOL, currentEOL);
if (strcmp(prevEOL, outputEOL) != 0)
filesAreIdentical = false;
}
}
#ifdef _WIN32 // Windows specific
/**
* WINDOWS function to display the last system error.
*/
void ASConsole::displayLastError()
{
LPSTR msgBuf;
DWORD lastError = GetLastError();
FormatMessage(
FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
NULL,
lastError,
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
(LPSTR) &msgBuf,
0,
NULL
);
// Display the string.
(*_err) << "Error (" << lastError << ") " << msgBuf << endl;
// Free the buffer.
LocalFree(msgBuf);
}
/**
* WINDOWS function to get the current directory.
* NOTE: getenv("CD") does not work for Windows Vista.
* The Windows function GetCurrentDirectory is used instead.
*
* @return The path of the current directory
*/
string ASConsole::getCurrentDirectory(const string &fileName_) const
{
char currdir[MAX_PATH];
currdir[0] = '\0';
if (!GetCurrentDirectory(sizeof(currdir), currdir))
error("Cannot find file", fileName_.c_str());
return string(currdir);
}
/**
* WINDOWS function to resolve wildcards and recurse into sub directories.
* The fileName vector is filled with the path and names of files to process.
*
* @param directory The path of the directory to be processed.
* @param wildcard The wildcard to be processed (e.g. *.cpp).
*/
void ASConsole::getFileNames(const string &directory, const string &wildcard)
{
vector subDirectory; // sub directories of directory
WIN32_FIND_DATA findFileData; // for FindFirstFile and FindNextFile
// Find the first file in the directory
// Find will get at least "." and "..".
string firstFile = directory + "\\*";
HANDLE hFind = FindFirstFile(firstFile.c_str(), &findFileData);
if (hFind == INVALID_HANDLE_VALUE)
{
// Error (3) The system cannot find the path specified.
// Error (123) The filename, directory name, or volume label syntax is incorrect.
// ::FindClose(hFind); before exiting
displayLastError();
error(_("Cannot open directory"), directory.c_str());
}
// save files and sub directories
do
{
// skip hidden or read only
if (findFileData.cFileName[0] == '.'
|| (findFileData.dwFileAttributes & FILE_ATTRIBUTE_HIDDEN)
|| (findFileData.dwFileAttributes & FILE_ATTRIBUTE_READONLY))
continue;
// is this a sub directory
if (findFileData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
{
if (!isRecursive)
continue;
// if a sub directory and recursive, save sub directory
string subDirectoryPath = directory + g_fileSeparator + findFileData.cFileName;
if (isPathExclued(subDirectoryPath))
printMsg(_("Exclude %s\n"), subDirectoryPath.substr(mainDirectoryLength));
else
subDirectory.push_back(subDirectoryPath);
continue;
}
// save the file name
string filePathName = directory + g_fileSeparator + findFileData.cFileName;
// check exclude before wildcmp to avoid "unmatched exclude" error
bool isExcluded = isPathExclued(filePathName);
// save file name if wildcard match
if (wildcmp(wildcard.c_str(), findFileData.cFileName))
{
if (isExcluded)
printMsg(_("Exclude %s\n"), filePathName.substr(mainDirectoryLength));
else
fileName.push_back(filePathName);
}
}
while (FindNextFile(hFind, &findFileData) != 0);
// check for processing error
::FindClose(hFind);
DWORD dwError = GetLastError();
if (dwError != ERROR_NO_MORE_FILES)
error("Error processing directory", directory.c_str());
// recurse into sub directories
// if not doing recursive subDirectory is empty
for (unsigned i = 0; i < subDirectory.size(); i++)
getFileNames(subDirectory[i], wildcard);
return;
}
/**
* WINDOWS function to format a number according to the current locale.
* This formats positive integers only, no float.
*
* @param num The number to be formatted.
* @param lcid The LCID of the locale to be used for testing.
* @return The formatted number.
*/
string ASConsole::getNumberFormat(int num, size_t lcid) const
{
#if defined(_MSC_VER) || defined(__MINGW32__) || defined(__BORLANDC__) || defined(__GNUC__)
// Compilers that don't support C++ locales should still support this assert.
// The C locale should be set but not the C++.
// This function is not necessary if the C++ locale is set.
// The locale().name() return value is not portable to all compilers.
assert(locale().name() == "C");
#endif
// convert num to a string
stringstream alphaNum;
alphaNum << num;
string number = alphaNum.str();
if (useAscii)
return number;
// format the number using the Windows API
if (lcid == 0)
lcid = LOCALE_USER_DEFAULT;
int outSize = ::GetNumberFormat(lcid, 0, number.c_str(), NULL, NULL, 0);
char* outBuf = new(nothrow) char[outSize];
if (outBuf == NULL)
return number;
::GetNumberFormat(lcid, 0, number.c_str(), NULL, outBuf, outSize);
string formattedNum(outBuf);
delete [] outBuf;
// remove the decimal
int decSize = ::GetLocaleInfo(lcid, LOCALE_SDECIMAL, NULL, 0);
char* decBuf = new(nothrow) char[decSize];
if (decBuf == NULL)
return number;
::GetLocaleInfo(lcid, LOCALE_SDECIMAL, decBuf, decSize);
size_t i = formattedNum.rfind(decBuf);
delete [] decBuf;
if (i != string::npos)
formattedNum.erase(i);
if (!formattedNum.length())
formattedNum = "0";
return formattedNum;
}
#else // not _WIN32
/**
* LINUX function to get the current directory.
* This is done if the fileName does not contain a path.
* It is probably from an editor sending a single file.
*
* @param fileName_ The filename is used only for the error message.
* @return The path of the current directory
*/
string ASConsole::getCurrentDirectory(const string &fileName_) const
{
char* currdir = getenv("PWD");
if (currdir == NULL)
error("Cannot find file", fileName_.c_str());
return string(currdir);
}
/**
* LINUX function to resolve wildcards and recurse into sub directories.
* The fileName vector is filled with the path and names of files to process.
*
* @param directory The path of the directory to be processed.
* @param wildcard The wildcard to be processed (e.g. *.cpp).
*/
void ASConsole::getFileNames(const string &directory, const string &wildcard)
{
struct dirent* entry; // entry from readdir()
struct stat statbuf; // entry from stat()
vector subDirectory; // sub directories of this directory
// errno is defined in and is set for errors in opendir, readdir, or stat
errno = 0;
DIR* dp = opendir(directory.c_str());
if (dp == NULL)
error(_("Cannot open directory"), directory.c_str());
// save the first fileName entry for this recursion
const unsigned firstEntry = fileName.size();
// save files and sub directories
while ((entry = readdir(dp)) != NULL)
{
// get file status
string entryFilepath = directory + g_fileSeparator + entry->d_name;
if (stat(entryFilepath.c_str(), &statbuf) != 0)
{
if (errno == EOVERFLOW) // file over 2 GB is OK
{
errno = 0;
continue;
}
perror("errno message");
error("Error getting file status in directory", directory.c_str());
}
// skip hidden or read only
if (entry->d_name[0] == '.' || !(statbuf.st_mode & S_IWUSR))
continue;
// if a sub directory and recursive, save sub directory
if (S_ISDIR(statbuf.st_mode) && isRecursive)
{
if (isPathExclued(entryFilepath))
printMsg(_("Exclude %s\n"), entryFilepath.substr(mainDirectoryLength));
else
subDirectory.push_back(entryFilepath);
continue;
}
// if a file, save file name
if (S_ISREG(statbuf.st_mode))
{
// check exclude before wildcmp to avoid "unmatched exclude" error
bool isExcluded = isPathExclued(entryFilepath);
// save file name if wildcard match
if (wildcmp(wildcard.c_str(), entry->d_name))
{
if (isExcluded)
printMsg(_("Exclude %s\n"), entryFilepath.substr(mainDirectoryLength));
else
fileName.push_back(entryFilepath);
}
}
}
if (closedir(dp) != 0)
{
perror("errno message");
error("Error reading directory", directory.c_str());
}
// sort the current entries for fileName
if (firstEntry < fileName.size())
sort(&fileName[firstEntry], &fileName[fileName.size()]);
// recurse into sub directories
// if not doing recursive, subDirectory is empty
if (subDirectory.size() > 1)
sort(subDirectory.begin(), subDirectory.end());
for (unsigned i = 0; i < subDirectory.size(); i++)
{
getFileNames(subDirectory[i], wildcard);
}
return;
}
/**
* LINUX function to get locale information and call getNumberFormat.
* This formats positive integers only, no float.
*
* @param num The number to be formatted.
* @param For compatibility with the Windows function.
* @return The formatted number.
*/
string ASConsole::getNumberFormat(int num, size_t) const
{
#if defined(_MSC_VER) || defined(__MINGW32__) || defined(__BORLANDC__) || defined(__GNUC__)
// Compilers that don't support C++ locales should still support this assert.
// The C locale should be set but not the C++.
// This function is not necessary if the C++ locale is set.
// The locale().name() return value is not portable to all compilers.
assert(locale().name() == "C");
#endif
// get the locale info
struct lconv* lc;
lc = localeconv();
// format the number
return getNumberFormat(num, lc->grouping, lc->thousands_sep);
}
/**
* LINUX function to format a number according to the current locale.
* This formats positive integers only, no float.
*
* @param num The number to be formatted.
* @param groupingArg The grouping string from the locale.
* @param separator The thousands group separator from the locale.
* @return The formatted number.
*/
string ASConsole::getNumberFormat(int num, const char* groupingArg, const char* separator) const
{
// convert num to a string
stringstream alphaNum;
alphaNum << num;
string number = alphaNum.str();
// format the number from right to left
string formattedNum;
size_t ig = 0; // grouping index
int grouping = groupingArg[ig];
int i = number.length();
// check for no grouping
if (grouping == 0)
grouping = number.length();
while (i > 0)
{
// extract a group of numbers
string group;
if (i < grouping)
group = number;
else
group = number.substr(i - grouping);
// update formatted number
formattedNum.insert(0, group);
i -= grouping;
if (i < 0)
i = 0;
if (i > 0)
formattedNum.insert(0, separator);
number.erase(i);
// update grouping
if (groupingArg[ig] != '\0'
&& groupingArg[ig + 1] != '\0')
grouping = groupingArg[++ig];
}
return formattedNum;
}
#endif // _WIN32
// get individual file names from the command-line file path
void ASConsole::getFilePaths(string &filePath)
{
fileName.clear();
targetDirectory = string();
targetFilename = string();
// separate directory and file name
size_t separator = filePath.find_last_of(g_fileSeparator);
if (separator == string::npos)
{
// if no directory is present, use the currently active directory
targetDirectory = getCurrentDirectory(filePath);
targetFilename = filePath;
mainDirectoryLength = targetDirectory.length() + 1; // +1 includes trailing separator
}
else
{
targetDirectory = filePath.substr(0, separator);
targetFilename = filePath.substr(separator + 1);
mainDirectoryLength = targetDirectory.length() + 1; // +1 includes trailing separator
}
if (targetFilename.length() == 0)
{
fprintf(stderr, _("Missing filename in %s\n"), filePath.c_str());
error();
}
// check filename for wildcards
hasWildcard = false;
if (targetFilename.find_first_of( "*?") != string::npos)
hasWildcard = true;
// clear exclude hits vector
for (size_t ix = 0; ix < excludeHitsVector.size(); ix++)
excludeHitsVector[ix] = false;
// If the filename is not quoted on Linux, bash will replace the
// wildcard instead of passing it to the program.
if (isRecursive && !hasWildcard)
{
fprintf(stderr, "%s\n", _("Recursive option with no wildcard"));
#ifndef _WIN32
fprintf(stderr, "%s\n", _("Did you intend quote the filename"));
#endif
error();
}
// display directory name for wildcard processing
if (hasWildcard)
{
printSeparatingLine();
printMsg(_("Directory %s\n"), targetDirectory + g_fileSeparator + targetFilename);
}
// create a vector of paths and file names to process
if (hasWildcard || isRecursive)
getFileNames(targetDirectory, targetFilename);
else
{
// verify a single file is not a directory (needed on Linux)
string entryFilepath = targetDirectory + g_fileSeparator + targetFilename;
struct stat statbuf;
if (stat(entryFilepath.c_str(), &statbuf) == 0 && (statbuf.st_mode & S_IFREG))
fileName.push_back(entryFilepath);
}
// check for unprocessed excludes
bool excludeErr = false;
for (size_t ix = 0; ix < excludeHitsVector.size(); ix++)
{
if (excludeHitsVector[ix] == false)
{
excludeErr = true;
if (!ignoreExcludeErrorsDisplay)
{
if (ignoreExcludeErrors)
printMsg(_("Exclude (unmatched) %s\n"), excludeVector[ix]);
else
fprintf(stderr, _("Exclude (unmatched) %s\n"), excludeVector[ix].c_str());
}
else
{
if (!ignoreExcludeErrors)
fprintf(stderr, _("Exclude (unmatched) %s\n"), excludeVector[ix].c_str());
}
}
}
if (excludeErr && !ignoreExcludeErrors)
{
if (hasWildcard && !isRecursive)
fprintf(stderr, "%s\n", _("Did you intend to use --recursive"));
error();
}
// check if files were found (probably an input error if not)
if (fileName.empty())
{
fprintf(stderr, _("No file to process %s\n"), filePath.c_str());
if (hasWildcard && !isRecursive)
fprintf(stderr, "%s\n", _("Did you intend to use --recursive"));
error();
}
if (hasWildcard)
printSeparatingLine();
}
bool ASConsole::fileNameVectorIsEmpty()
{
return fileNameVector.empty();
}
bool ASConsole::isOption(const string &arg, const char* op)
{
return arg.compare(op) == 0;
}
bool ASConsole::isOption(const string &arg, const char* a, const char* b)
{
return (isOption(arg, a) || isOption(arg, b));
}
bool ASConsole::isParamOption(const string &arg, const char* option)
{
bool retVal = arg.compare(0, strlen(option), option) == 0;
// if comparing for short option, 2nd char of arg must be numeric
if (retVal && strlen(option) == 1 && arg.length() > 1)
if (!isdigit((unsigned char)arg[1]))
retVal = false;
return retVal;
}
// compare a path to the exclude vector
// used for both directories and filenames
// updates the g_excludeHitsVector
// return true if a match
bool ASConsole::isPathExclued(const string &subPath)
{
bool retVal = false;
// read the exclude vector checking for a match
for (size_t i = 0; i < excludeVector.size(); i++)
{
string exclude = excludeVector[i];
if (subPath.length() < exclude.length())
continue;
size_t compareStart = subPath.length() - exclude.length();
// subPath compare must start with a directory name
if (compareStart > 0)
{
char lastPathChar = subPath[compareStart - 1];
if (lastPathChar != g_fileSeparator)
continue;
}
string compare = subPath.substr(compareStart);
if (!g_isCaseSensitive)
{
// make it case insensitive for Windows
for (size_t j = 0; j < compare.length(); j++)
compare[j] = (char)tolower(compare[j]);
for (size_t j = 0; j < exclude.length(); j++)
exclude[j] = (char)tolower(exclude[j]);
}
// compare sub directory to exclude data - must check them all
if (compare == exclude)
{
excludeHitsVector[i] = true;
retVal = true;
break;
}
}
return retVal;
}
void ASConsole::printHelp() const
{
(*_err) << endl;
(*_err) << " Artistic Style " << g_version << endl;
(*_err) << " Maintained by: Jim Pattee\n";
(*_err) << " Original Author: Tal Davidson\n";
(*_err) << endl;
(*_err) << "Usage : astyle [options] Source1.cpp Source2.cpp [...]\n";
(*_err) << " astyle [options] < Original > Beautified\n";
(*_err) << endl;
(*_err) << "When indenting a specific file, the resulting indented file RETAINS the\n";
(*_err) << "original file-name. The original pre-indented file is renamed, with a\n";
(*_err) << "suffix of \".orig\" added to the original filename.\n";
(*_err) << endl;
(*_err) << "Wildcards (* and ?) may be used in the filename.\n";
(*_err) << "A \'recursive\' option can process directories recursively.\n";
(*_err) << endl;
(*_err) << "By default, astyle is set up to indent C/C++/C#/Java files, with four\n";
(*_err) << "spaces per indent, a maximal indentation of 40 spaces inside continuous\n";
(*_err) << "statements, a minimum indentation of eight spaces inside conditional\n";
(*_err) << "statements, and NO formatting options.\n";
(*_err) << endl;
(*_err) << "Option Format:\n";
(*_err) << "--------------\n";
(*_err) << " Long options (starting with '--') must be written one at a time.\n";
(*_err) << " Short options (starting with '-') may be appended together.\n";
(*_err) << " Thus, -bps4 is the same as -b -p -s4.\n";
(*_err) << endl;
(*_err) << "Default Option File:\n";
(*_err) << "---------------------\n";
(*_err) << " Artistic Style looks for a default options file in the\n";
(*_err) << " following order:\n";
(*_err) << " 1. The contents of the ARTISTIC_STYLE_OPTIONS environment\n";
(*_err) << " variable if it exists.\n";
(*_err) << " 2. The file called .astylerc in the directory pointed to by the\n";
(*_err) << " HOME environment variable ( i.e. $HOME/.astylerc ).\n";
(*_err) << " 3. The file called astylerc in the directory pointed to by the\n";
(*_err) << " USERPROFILE environment variable ( i.e. %USERPROFILE%\\astylerc ).\n";
(*_err) << " If a default options file is found, the options in this file\n";
(*_err) << " will be parsed BEFORE the command-line options.\n";
(*_err) << " Long options within the default option file may be written without\n";
(*_err) << " the preliminary '--'.\n";
(*_err) << endl;
(*_err) << "Bracket Style Options:\n";
(*_err) << "----------------------\n";
(*_err) << " --style=allman OR --style=ansi OR --style=bsd\n";
(*_err) << " OR --style=break OR -A1\n";
(*_err) << " Allman style formatting/indenting.\n";
(*_err) << " Broken brackets.\n";
(*_err) << endl;
(*_err) << " --style=java OR --style=attach OR -A2\n";
(*_err) << " Java style formatting/indenting.\n";
(*_err) << " Attached brackets.\n";
(*_err) << endl;
(*_err) << " --style=kr OR --style=k&r OR --style=k/r OR -A3\n";
(*_err) << " Kernighan & Ritchie style formatting/indenting.\n";
(*_err) << " Linux brackets.\n";
(*_err) << endl;
(*_err) << " --style=stroustrup OR -A4\n";
(*_err) << " Stroustrup style formatting/indenting.\n";
(*_err) << " Stroustrup brackets.\n";
(*_err) << endl;
(*_err) << " --style=whitesmith OR -A5\n";
(*_err) << " Whitesmith style formatting/indenting.\n";
(*_err) << " Broken, indented brackets.\n";
(*_err) << " Indented class blocks and switch blocks.\n";
(*_err) << endl;
(*_err) << " --style=banner OR -A6\n";
(*_err) << " Banner style formatting/indenting.\n";
(*_err) << " Attached, indented brackets.\n";
(*_err) << " Indented class blocks and switch blocks.\n";
(*_err) << endl;
(*_err) << " --style=gnu OR -A7\n";
(*_err) << " GNU style formatting/indenting.\n";
(*_err) << " Broken brackets, indented blocks.\n";
(*_err) << endl;
(*_err) << " --style=linux OR --style=knf OR -A8\n";
(*_err) << " Linux style formatting/indenting.\n";
(*_err) << " Linux brackets, minimum conditional indent is one-half indent.\n";
(*_err) << endl;
(*_err) << " --style=horstmann OR -A9\n";
(*_err) << " Horstmann style formatting/indenting.\n";
(*_err) << " Run-in brackets, indented switches.\n";
(*_err) << endl;
(*_err) << " --style=1tbs OR --style=otbs OR -A10\n";
(*_err) << " One True Brace Style formatting/indenting.\n";
(*_err) << " Linux brackets, add brackets to all conditionals.\n";
(*_err) << endl;
(*_err) << " --style=google OR -A14\n";
(*_err) << " Google style formatting/indenting.\n";
(*_err) << " Attached brackets, indented class modifiers.\n";
(*_err) << endl;
(*_err) << " --style=pico OR -A11\n";
(*_err) << " Pico style formatting/indenting.\n";
(*_err) << " Run-in opening brackets and attached closing brackets.\n";
(*_err) << " Uses keep one line blocks and keep one line statements.\n";
(*_err) << endl;
(*_err) << " --style=lisp OR -A12\n";
(*_err) << " Lisp style formatting/indenting.\n";
(*_err) << " Attached opening brackets and attached closing brackets.\n";
(*_err) << " Uses keep one line statements.\n";
(*_err) << endl;
(*_err) << "Tab Options:\n";
(*_err) << "------------\n";
(*_err) << " default indent option\n";
(*_err) << " If no indentation option is set, the default\n";
(*_err) << " option of 4 spaces per indent will be used.\n";
(*_err) << endl;
(*_err) << " --indent=spaces=# OR -s#\n";
(*_err) << " Indent using # spaces per indent. Not specifying #\n";
(*_err) << " will result in a default of 4 spaces per indent.\n";
(*_err) << endl;
(*_err) << " --indent=tab OR --indent=tab=# OR -t OR -t#\n";
(*_err) << " Indent using tab characters, assuming that each\n";
(*_err) << " indent is # spaces long. Not specifying # will result\n";
(*_err) << " in a default assumption of 4 spaces per indent.\n";
(*_err) << endl;
(*_err) << " --indent=force-tab=# OR -T#\n";
(*_err) << " Indent using tab characters, assuming that each\n";
(*_err) << " indent is # spaces long. Force tabs to be used in areas\n";
(*_err) << " AStyle would prefer to use spaces.\n";
(*_err) << endl;
(*_err) << " --indent=force-tab-x=# OR -xT#\n";
(*_err) << " Allows the tab length to be set to a length that is different\n";
(*_err) << " from the indent length. This may cause the indentation to be\n";
(*_err) << " a mix of both spaces and tabs. This option sets the tab length.\n";
(*_err) << endl;
(*_err) << "Bracket Modify Options:\n";
(*_err) << "-------------------------\n";
(*_err) << " --attach-namespaces OR -xn\n";
(*_err) << " Attach brackets to a namespace statement.\n";
(*_err) << endl;
(*_err) << " --attach-classes OR -xc\n";
(*_err) << " Attach brackets to a class statement.\n";
(*_err) << endl;
(*_err) << " --attach-inlines OR -xl\n";
(*_err) << " Attach brackets to class inline function definitions.\n";
(*_err) << endl;
(*_err) << " --attach-extern-c OR -xk\n";
(*_err) << " Attach brackets to an extern \"C\" statement.\n";
(*_err) << endl;
(*_err) << "Indentation Options:\n";
(*_err) << "--------------------\n";
(*_err) << " --indent-classes OR -C\n";
(*_err) << " Indent 'class' blocks so that the entire block is indented.\n";
(*_err) << endl;
(*_err) << " --indent-modifiers OR -xG\n";
(*_err) << " Indent 'class' access modifiers, 'public:', 'protected:' or\n";
(*_err) << " 'private:', one half indent. The rest of the class is not\n";
(*_err) << " indented. \n";
(*_err) << endl;
(*_err) << " --indent-switches OR -S\n";
(*_err) << " Indent 'switch' blocks, so that the inner 'case XXX:'\n";
(*_err) << " headers are indented in relation to the switch block.\n";
(*_err) << endl;
(*_err) << " --indent-cases OR -K\n";
(*_err) << " Indent case blocks from the 'case XXX:' headers.\n";
(*_err) << " Case statements not enclosed in blocks are NOT indented.\n";
(*_err) << endl;
(*_err) << " --indent-namespaces OR -N\n";
(*_err) << " Indent the contents of namespace blocks.\n";
(*_err) << endl;
(*_err) << " --indent-labels OR -L\n";
(*_err) << " Indent labels so that they appear one indent less than\n";
(*_err) << " the current indentation level, rather than being\n";
(*_err) << " flushed completely to the left (which is the default).\n";
(*_err) << endl;
(*_err) << " --indent-preproc-define OR -w\n";
(*_err) << " --indent-preprocessor has been depreciated.\n";
(*_err) << " Indent multi-line preprocessor #define statements.\n";
(*_err) << endl;
(*_err) << " --indent-preproc-cond OR -xw\n";
(*_err) << " Indent preprocessor conditional statements #if/#else/#endif\n";
(*_err) << " to the same level as the source code.\n";
(*_err) << endl;
(*_err) << " --indent-col1-comments OR -Y\n";
(*_err) << " Indent line comments that start in column one.\n";
(*_err) << endl;
(*_err) << " --min-conditional-indent=# OR -m#\n";
(*_err) << " Indent a minimal # spaces in a continuous conditional\n";
(*_err) << " belonging to a conditional header.\n";
(*_err) << " The valid values are:\n";
(*_err) << " 0 - no minimal indent.\n";
(*_err) << " 1 - indent at least one additional indent.\n";
(*_err) << " 2 - indent at least two additional indents.\n";
(*_err) << " 3 - indent at least one-half an additional indent.\n";
(*_err) << " The default value is 2, two additional indents.\n";
(*_err) << endl;
(*_err) << " --max-instatement-indent=# OR -M#\n";
(*_err) << " Indent a maximal # spaces in a continuous statement,\n";
(*_err) << " relative to the previous line.\n";
(*_err) << " The valid values are 40 thru 120.\n";
(*_err) << " The default value is 40.\n";
(*_err) << endl;
(*_err) << "Padding Options:\n";
(*_err) << "----------------\n";
(*_err) << " --break-blocks OR -f\n";
(*_err) << " Insert empty lines around unrelated blocks, labels, classes, ...\n";
(*_err) << endl;
(*_err) << " --break-blocks=all OR -F\n";
(*_err) << " Like --break-blocks, except also insert empty lines \n";
(*_err) << " around closing headers (e.g. 'else', 'catch', ...).\n";
(*_err) << endl;
(*_err) << " --pad-oper OR -p\n";
(*_err) << " Insert space padding around operators.\n";
(*_err) << endl;
(*_err) << " --pad-paren OR -P\n";
(*_err) << " Insert space padding around parenthesis on both the outside\n";
(*_err) << " and the inside.\n";
(*_err) << endl;
(*_err) << " --pad-paren-out OR -d\n";
(*_err) << " Insert space padding around parenthesis on the outside only.\n";
(*_err) << endl;
(*_err) << " --pad-first-paren-out OR -xd\n";
(*_err) << " Insert space padding around first parenthesis in a series on\n";
(*_err) << " the outside only.\n";
(*_err) << endl;
(*_err) << " --pad-paren-in OR -D\n";
(*_err) << " Insert space padding around parenthesis on the inside only.\n";
(*_err) << endl;
(*_err) << " --pad-header OR -H\n";
(*_err) << " Insert space padding after paren headers (e.g. 'if', 'for'...).\n";
(*_err) << endl;
(*_err) << " --unpad-paren OR -U\n";
(*_err) << " Remove unnecessary space padding around parenthesis. This\n";
(*_err) << " can be used in combination with the 'pad' options above.\n";
(*_err) << endl;
(*_err) << " --delete-empty-lines OR -xd\n";
(*_err) << " Delete empty lines within a function or method.\n";
(*_err) << " It will NOT delete lines added by the break-blocks options.\n";
(*_err) << endl;
(*_err) << " --fill-empty-lines OR -E\n";
(*_err) << " Fill empty lines with the white space of their\n";
(*_err) << " previous lines.\n";
(*_err) << endl;
(*_err) << " --align-pointer=type OR -k1\n";
(*_err) << " --align-pointer=middle OR -k2\n";
(*_err) << " --align-pointer=name OR -k3\n";
(*_err) << " Attach a pointer or reference operator (*, &, or ^) to either\n";
(*_err) << " the operator type (left), middle, or operator name (right).\n";
(*_err) << " To align the reference separately use --align-reference.\n";
(*_err) << endl;
(*_err) << " --align-reference=none OR -W0\n";
(*_err) << " --align-reference=type OR -W1\n";
(*_err) << " --align-reference=middle OR -W2\n";
(*_err) << " --align-reference=name OR -W3\n";
(*_err) << " Attach a reference operator (&) to either\n";
(*_err) << " the operator type (left), middle, or operator name (right).\n";
(*_err) << " If not set, follow pointer alignment.\n";
(*_err) << endl;
(*_err) << "Formatting Options:\n";
(*_err) << "-------------------\n";
(*_err) << " --break-closing-brackets OR -y\n";
(*_err) << " Break brackets before closing headers (e.g. 'else', 'catch', ...).\n";
(*_err) << " Use with --style=java, --style=kr, --style=stroustrup,\n";
(*_err) << " --style=linux, or --style=1tbs.\n";
(*_err) << endl;
(*_err) << " --break-elseifs OR -e\n";
(*_err) << " Break 'else if()' statements into two different lines.\n";
(*_err) << endl;
(*_err) << " --add-brackets OR -j\n";
(*_err) << " Add brackets to unbracketed one line conditional statements.\n";
(*_err) << endl;
(*_err) << " --add-one-line-brackets OR -J\n";
(*_err) << " Add one line brackets to unbracketed one line conditional\n";
(*_err) << " statements.\n";
(*_err) << endl;
(*_err) << " --remove-brackets OR -xj\n";
(*_err) << " Remove brackets from a bracketed one line conditional statements.\n";
(*_err) << endl;
(*_err) << " --keep-one-line-blocks OR -O\n";
(*_err) << " Don't break blocks residing completely on one line.\n";
(*_err) << endl;
(*_err) << " --keep-one-line-statements OR -o\n";
(*_err) << " Don't break lines containing multiple statements into\n";
(*_err) << " multiple single-statement lines.\n";
(*_err) << endl;
(*_err) << " --convert-tabs OR -c\n";
(*_err) << " Convert tabs to the appropriate number of spaces.\n";
(*_err) << endl;
(*_err) << " --close-templates OR -xy\n";
(*_err) << " Close ending angle brackets on template definitions.\n";
(*_err) << endl;
(*_err) << " --remove-comment-prefix OR -xp\n";
(*_err) << " Remove the leading '*' prefix on multi-line comments and\n";
(*_err) << " indent the comment text one indent.\n";
(*_err) << endl;
(*_err) << " --max-code-length=# OR -xC#\n";
(*_err) << " --break-after-logical OR -xL\n";
(*_err) << " max-code-length=# will break the line if it exceeds more than\n";
(*_err) << " # characters. The valid values are 50 thru 200.\n";
(*_err) << " If the line contains logical conditionals they will be placed\n";
(*_err) << " first on the new line. The option break-after-logical will\n";
(*_err) << " cause the logical conditional to be placed last on the\n";
(*_err) << " previous line.\n";
(*_err) << endl;
(*_err) << " --mode=c\n";
(*_err) << " Indent a C or C++ source file (this is the default).\n";
(*_err) << endl;
(*_err) << " --mode=java\n";
(*_err) << " Indent a Java source file.\n";
(*_err) << endl;
(*_err) << " --mode=cs\n";
(*_err) << " Indent a C# source file.\n";
(*_err) << endl;
(*_err) << "Objective-C Options:\n";
(*_err) << "--------------------\n";
(*_err) << " --align-method-colon OR -xM\n";
(*_err) << " Align the colons in an Objective-C method definition.\n";
(*_err) << endl;
(*_err) << " --pad-method-prefix OR -xQ\n";
(*_err) << " Insert space padding after the '-' or '+' Objective-C\n";
(*_err) << " method prefix.\n";
(*_err) << endl;
(*_err) << " --unpad-method-prefix OR -xR\n";
(*_err) << " Remove all space padding after the '-' or '+' Objective-C\n";
(*_err) << " method prefix.\n";
(*_err) << endl;
(*_err) << " --pad-method-colon=none OR -xP\n";
(*_err) << " --pad-method-colon=all OR -xP1\n";
(*_err) << " --pad-method-colon=after OR -xP2\n";
(*_err) << " --pad-method-colon=before OR -xP3\n";
(*_err) << " Add or remove space padding before or after the colons in an\n";
(*_err) << " Objective-C method call.\n";
(*_err) << endl;
(*_err) << "Other Options:\n";
(*_err) << "--------------\n";
(*_err) << " --suffix=####\n";
(*_err) << " Append the suffix #### instead of '.orig' to original filename.\n";
(*_err) << endl;
(*_err) << " --suffix=none OR -n\n";
(*_err) << " Do not retain a backup of the original file.\n";
(*_err) << endl;
(*_err) << " --recursive OR -r OR -R\n";
(*_err) << " Process subdirectories recursively.\n";
(*_err) << endl;
(*_err) << " --exclude=####\n";
(*_err) << " Specify a file or directory #### to be excluded from processing.\n";
(*_err) << endl;
(*_err) << " --ignore-exclude-errors OR -i\n";
(*_err) << " Allow processing to continue if there are errors in the exclude=###\n";
(*_err) << " options. It will display the unmatched excludes.\n";
(*_err) << endl;
(*_err) << " --ignore-exclude-errors-x OR -xi\n";
(*_err) << " Allow processing to continue if there are errors in the exclude=###\n";
(*_err) << " options. It will NOT display the unmatched excludes.\n";
(*_err) << endl;
(*_err) << " --errors-to-stdout OR -X\n";
(*_err) << " Print errors and help information to standard-output rather than\n";
(*_err) << " to standard-error.\n";
(*_err) << endl;
(*_err) << " --preserve-date OR -Z\n";
(*_err) << " Preserve the original file's date and time modified. The time\n";
(*_err) << " modified will be changed a few micro seconds to force a compile.\n";
(*_err) << endl;
(*_err) << " --verbose OR -v\n";
(*_err) << " Verbose mode. Extra informational messages will be displayed.\n";
(*_err) << endl;
(*_err) << " --formatted OR -Q\n";
(*_err) << " Formatted display mode. Display only the files that have been\n";
(*_err) << " formatted.\n";
(*_err) << endl;
(*_err) << " --quiet OR -q\n";
(*_err) << " Quiet mode. Suppress all output except error messages.\n";
(*_err) << endl;
(*_err) << " --lineend=windows OR -z1\n";
(*_err) << " --lineend=linux OR -z2\n";
(*_err) << " --lineend=macold OR -z3\n";
(*_err) << " Force use of the specified line end style. Valid options\n";
(*_err) << " are windows (CRLF), linux (LF), and macold (CR).\n";
(*_err) << endl;
(*_err) << "Command Line Only:\n";
(*_err) << "------------------\n";
(*_err) << " --options=####\n";
(*_err) << " Specify an options file #### to read and use.\n";
(*_err) << endl;
(*_err) << " --options=none\n";
(*_err) << " Disable the default options file.\n";
(*_err) << " Only the command-line parameters will be used.\n";
(*_err) << endl;
(*_err) << " --ascii OR -I\n";
(*_err) << " The displayed output will be ascii characters only.\n";
(*_err) << endl;
(*_err) << " --version OR -V\n";
(*_err) << " Print version number.\n";
(*_err) << endl;
(*_err) << " --help OR -h OR -?\n";
(*_err) << " Print this help message.\n";
(*_err) << endl;
}
/**
* Process files in the fileNameVector.
*/
void ASConsole::processFiles()
{
if (isVerbose)
printVerboseHeader();
clock_t startTime = clock(); // start time of file formatting
// loop thru input fileNameVector and process the files
for (size_t i = 0; i < fileNameVector.size(); i++)
{
getFilePaths(fileNameVector[i]);
// loop thru fileName vector formatting the files
for (size_t j = 0; j < fileName.size(); j++)
formatFile(fileName[j]);
}
// files are processed, display stats
if (isVerbose)
printVerboseStats(startTime);
}
// process options from the command line and options file
// build the vectors fileNameVector, excludeVector, optionsVector, and fileOptionsVector
void ASConsole::processOptions(vector &argvOptions)
{
string arg;
bool ok = true;
bool shouldParseOptionsFile = true;
// get command line options
for (size_t i = 0; i < argvOptions.size(); i++)
{
arg = argvOptions[i];
if ( isOption(arg, "-I" )
|| isOption(arg, "--ascii") )
{
useAscii = true;
setlocale(LC_ALL, "C"); // use English decimal indicator
localizer.setLanguageFromName("en");
}
else if ( isOption(arg, "--options=none") )
{
shouldParseOptionsFile = false;
}
else if ( isParamOption(arg, "--options=") )
{
optionsFileName = getParam(arg, "--options=");
optionsFileRequired = true;
if (optionsFileName.compare("") == 0)
setOptionsFileName(" ");
}
else if ( isOption(arg, "-h")
|| isOption(arg, "--help")
|| isOption(arg, "-?") )
{
printHelp();
exit(EXIT_SUCCESS);
}
else if ( isOption(arg, "-V" )
|| isOption(arg, "--version") )
{
(*_err) << "Artistic Style Version " << g_version << endl;
exit(EXIT_SUCCESS);
}
else if (arg[0] == '-')
{
optionsVector.push_back(arg);
}
else // file-name
{
standardizePath(arg);
fileNameVector.push_back(arg);
}
}
// get options file path and name
if (shouldParseOptionsFile)
{
if (optionsFileName.compare("") == 0)
{
char* env = getenv("ARTISTIC_STYLE_OPTIONS");
if (env != NULL)
setOptionsFileName(env);
}
if (optionsFileName.compare("") == 0)
{
char* env = getenv("HOME");
if (env != NULL)
setOptionsFileName(string(env) + "/.astylerc");
}
if (optionsFileName.compare("") == 0)
{
char* env = getenv("USERPROFILE");
if (env != NULL)
setOptionsFileName(string(env) + "/astylerc");
}
if (optionsFileName.compare("") != 0)
standardizePath(optionsFileName);
}
// create the options file vector and parse the options for errors
ASOptions options(formatter);
if (optionsFileName.compare("") != 0)
{
ifstream optionsIn(optionsFileName.c_str());
if (optionsIn)
{
options.importOptions(optionsIn, fileOptionsVector);
ok = options.parseOptions(fileOptionsVector,
string(_("Invalid option file options:")));
}
else
{
if (optionsFileRequired)
error(_("Cannot open options file"), optionsFileName.c_str());
optionsFileName.clear();
}
optionsIn.close();
}
if (!ok)
{
(*_err) << options.getOptionErrors() << endl;
(*_err) << _("For help on options type 'astyle -h'") << endl;
error();
}
// parse the command line options vector for errors
ok = options.parseOptions(optionsVector,
string(_("Invalid command line options:")));
if (!ok)
{
(*_err) << options.getOptionErrors() << endl;
(*_err) << _("For help on options type 'astyle -h'") << endl;
error();
}
}
// remove a file and check for an error
void ASConsole::removeFile(const char* fileName_, const char* errMsg) const
{
if (remove(fileName_))
{
if (errno == ENOENT) // no file is OK
errno = 0;
if (errno)
{
perror("errno message");
error(errMsg, fileName_);
}
}
}
// rename a file and check for an error
void ASConsole::renameFile(const char* oldFileName, const char* newFileName, const char* errMsg) const
{
int result = rename(oldFileName, newFileName);
if (result != 0)
{
// if file still exists the remove needs more time - retry
if (errno == EEXIST)
{
errno = 0;
waitForRemove(newFileName);
result = rename(oldFileName, newFileName);
}
if (result != 0)
{
perror("errno message");
error(errMsg, oldFileName);
}
}
}
// make sure file separators are correct type (Windows or Linux)
// remove ending file separator
// remove beginning file separator if requested and NOT a complete file path
void ASConsole::standardizePath(string &path, bool removeBeginningSeparator /*false*/) const
{
#ifdef __VMS
struct FAB fab;
struct NAML naml;
char less[NAML$C_MAXRSS];
char sess[NAM$C_MAXRSS];
int r0_status;
// If we are on a VMS system, translate VMS style filenames to unix
// style.
fab = cc$rms_fab;
fab.fab$l_fna = (char*) - 1;
fab.fab$b_fns = 0;
fab.fab$l_naml = &naml;
naml = cc$rms_naml;
strcpy (sess, path.c_str());
naml.naml$l_long_filename = (char*)sess;
naml.naml$l_long_filename_size = path.length();
naml.naml$l_long_expand = less;
naml.naml$l_long_expand_alloc = sizeof (less);
naml.naml$l_esa = sess;
naml.naml$b_ess = sizeof (sess);
naml.naml$v_no_short_upcase = 1;
r0_status = sys$parse (&fab);
if (r0_status == RMS$_SYN)
{
error("File syntax error", path.c_str());
}
else
{
if (!$VMS_STATUS_SUCCESS(r0_status))
{
(void)lib$signal (r0_status);
}
}
less[naml.naml$l_long_expand_size - naml.naml$b_ver] = '\0';
sess[naml.naml$b_esl - naml.naml$b_ver] = '\0';
if (naml.naml$l_long_expand_size > naml.naml$b_esl)
{
path = decc$translate_vms (less);
}
else
{
path = decc$translate_vms (sess);
}
#endif /* __VMS */
// make sure separators are correct type (Windows or Linux)
for (size_t i = 0; i < path.length(); i++)
{
i = path.find_first_of("/\\", i);
if (i == string::npos)
break;
path[i] = g_fileSeparator;
}
// The following was removed in release 2.02 - jimp
// // remove separator from the end
// if (path[path.length()-1] == g_fileSeparator)
// path.erase(path.length()-1, 1);
// remove beginning separator if requested
if (removeBeginningSeparator && (path[0] == g_fileSeparator))
path.erase(0, 1);
}
void ASConsole::printMsg(const char* msg, const string &data) const
{
if (isQuiet)
return;
printf(msg, data.c_str());
}
void ASConsole::printSeparatingLine() const
{
string line;
for (size_t i = 0; i < 60; i++)
line.append("-");
printMsg("%s\n", line);
}
void ASConsole::printVerboseHeader() const
{
assert(isVerbose);
if (isQuiet)
return;
// get the date
struct tm* ptr;
time_t lt;
char str[20];
lt = time(NULL);
ptr = localtime(<);
strftime(str, 20, "%x", ptr);
// print the header
printf("Artistic Style %s %s\n", g_version, str);
// print options file
if (!optionsFileName.empty())
printf(_("Using default options file %s\n"), optionsFileName.c_str());
}
void ASConsole::printVerboseStats(clock_t startTime) const
{
assert(isVerbose);
if (isQuiet)
return;
if (hasWildcard)
printSeparatingLine();
string formatted = getNumberFormat(filesFormatted);
string unchanged = getNumberFormat(filesUnchanged);
printf(_(" %s formatted %s unchanged "), formatted.c_str(), unchanged.c_str());
// show processing time
clock_t stopTime = clock();
float secs = (stopTime - startTime) / float (CLOCKS_PER_SEC);
if (secs < 60)
{
if (secs < 2.0)
printf("%.2f", secs);
else if (secs < 20.0)
printf("%.1f", secs);
else
printf("%.0f", secs);
printf("%s", _(" seconds "));
}
else
{
// show minutes and seconds if time is greater than one minute
int min = (int) secs / 60;
secs -= min * 60;
int minsec = int (secs + .5);
printf(_("%d min %d sec "), min, minsec);
}
string lines = getNumberFormat(linesOut);
printf(_("%s lines\n"), lines.c_str());
}
void ASConsole::sleep(int seconds) const
{
clock_t endwait;
endwait = clock_t (clock () + seconds * CLOCKS_PER_SEC);
while (clock() < endwait) {}
}
bool ASConsole::stringEndsWith(const string &str, const string &suffix) const
{
int strIndex = (int) str.length() - 1;
int suffixIndex = (int) suffix.length() - 1;
while (strIndex >= 0 && suffixIndex >= 0)
{
if (tolower(str[strIndex]) != tolower(suffix[suffixIndex]))
return false;
--strIndex;
--suffixIndex;
}
// suffix longer than string
if (strIndex < 0 && suffixIndex >= 0)
return false;
return true;
}
// Swap the two low order bytes of an integer value
// and convert 8 bit encoding to 16 bit.
int ASConsole::swap8to16bit(int value) const
{
return ( ((value & 0xFF) << 8) + (value >> 8) );
}
// Swap the two low order bytes of a 16 bit integer value.
int ASConsole::swap16bit(int value) const
{
return ( ((value & 0xff) << 8) | ((value & 0xff00) >> 8) );
}
void ASConsole::updateExcludeVector(string suffixParam)
{
excludeVector.push_back(suffixParam);
standardizePath(excludeVector.back(), true);
excludeHitsVector.push_back(false);
}
// Adapted from SciTE UniConversion.cxx.
// Copyright 1998-2001 by Neil Hodgson
// Modified for Artistic Style by Jim Pattee.
//
// Compute the length of an output utf-8 file given a utf-16 file.
// Input tlen is the size in BYTES (not wchar_t).
size_t ASConsole::Utf8LengthFromUtf16(const char* data, size_t tlen, FileEncoding encoding) const
{
enum { SURROGATE_LEAD_FIRST = 0xD800 };
enum { SURROGATE_TRAIL_LAST = 0xDFFF };
size_t len = 0;
size_t wcharLen = tlen / 2;
const short* uptr = reinterpret_cast(data);
for (size_t i = 0; i < wcharLen && uptr[i];)
{
size_t uch = encoding == UTF_16BE ? swap16bit(uptr[i]) : uptr[i];
if (uch < 0x80)
{
len++;
}
else if (uch < 0x800)
{
len += 2;
}
else if ((uch >= SURROGATE_LEAD_FIRST) && (uch <= SURROGATE_TRAIL_LAST))
{
len += 4;
i++;
}
else
{
len += 3;
}
i++;
}
return len;
}
// Adapted from SciTE Utf8_16.cxx.
// Copyright (C) 2002 Scott Kirkwood.
// Modified for Artistic Style by Jim Pattee.
//
// Convert a utf-8 file to utf-16.
size_t ASConsole::Utf8ToUtf16(char* utf8In, size_t inLen, FileEncoding encoding, char* utf16Out) const
{
typedef unsigned short utf16; // 16 bits
typedef unsigned char ubyte; // 8 bits
enum { SURROGATE_LEAD_FIRST = 0xD800 };
enum { SURROGATE_LEAD_LAST = 0xDBFF };
enum { SURROGATE_TRAIL_FIRST = 0xDC00 };
enum { SURROGATE_TRAIL_LAST = 0xDFFF };
enum { SURROGATE_FIRST_VALUE = 0x10000 };
enum eState { eStart, eSecondOf4Bytes, ePenultimate, eFinal };
int nCur = 0;
ubyte* pRead = reinterpret_cast(utf8In);
utf16* pCur = reinterpret_cast(utf16Out);
const ubyte* pEnd = pRead + inLen;
const utf16* pCurStart = pCur;
eState eState = eStart;
// the BOM will automatically be converted to utf-16
while (pRead < pEnd)
{
switch (eState)
{
case eStart:
if ((0xF0 & *pRead) == 0xF0)
{
nCur = (0x7 & *pRead) << 18;
eState = eSecondOf4Bytes;
}
else if ((0xE0 & *pRead) == 0xE0)
{
nCur = (~0xE0 & *pRead) << 12;
eState = ePenultimate;
}
else if ((0xC0 & *pRead) == 0xC0)
{
nCur = (~0xC0 & *pRead) << 6;
eState = eFinal;
}
else
{
nCur = *pRead;
eState = eStart;
}
break;
case eSecondOf4Bytes:
nCur |= (0x3F & *pRead) << 12;
eState = ePenultimate;
break;
case ePenultimate:
nCur |= (0x3F & *pRead) << 6;
eState = eFinal;
break;
case eFinal:
nCur |= (0x3F & *pRead);
eState = eStart;
break;
default:
error("Bad eState value", "Utf8ToUtf16()");
}
++pRead;
if (eState == eStart)
{
int codePoint = nCur;
if (codePoint >= SURROGATE_FIRST_VALUE)
{
codePoint -= SURROGATE_FIRST_VALUE;
int lead = (codePoint >> 10) + SURROGATE_LEAD_FIRST;
*pCur++ = static_cast((encoding == UTF_16BE) ?
swap8to16bit(lead) : lead);
int trail = (codePoint & 0x3ff) + SURROGATE_TRAIL_FIRST;
*pCur++ = static_cast((encoding == UTF_16BE) ?
swap8to16bit(trail) : trail);
}
else
{
*pCur++ = static_cast((encoding == UTF_16BE) ?
swap8to16bit(codePoint) : codePoint);
}
}
}
// return value is the output length in BYTES (not wchar_t)
return (pCur - pCurStart) * 2;
}
// Adapted from SciTE UniConversion.cxx.
// Copyright 1998-2001 by Neil Hodgson
// Modified for Artistic Style by Jim Pattee.
//
// Compute the length of an output utf-16 file given a utf-8 file.
// Return value is the size in BYTES (not wchar_t).
size_t ASConsole::Utf16LengthFromUtf8(const char* data, size_t len) const
{
size_t ulen = 0;
size_t charLen;
for (size_t i = 0; i < len;)
{
unsigned char ch = static_cast(data[i]);
if (ch < 0x80)
charLen = 1;
else if (ch < 0x80 + 0x40 + 0x20)
charLen = 2;
else if (ch < 0x80 + 0x40 + 0x20 + 0x10)
charLen = 3;
else
{
charLen = 4;
ulen++;
}
i += charLen;
ulen++;
}
// return value is the length in bytes (not wchar_t)
return ulen * 2;
}
// Adapted from SciTE Utf8_16.cxx.
// Copyright (C) 2002 Scott Kirkwood.
// Modified for Artistic Style by Jim Pattee.
//
// Convert a utf-16 file to utf-8.
size_t ASConsole::Utf16ToUtf8(char* utf16In, size_t inLen, FileEncoding encoding,
bool firstBlock, char* utf8Out) const
{
typedef unsigned short utf16; // 16 bits
typedef unsigned char ubyte; // 8 bits
enum { SURROGATE_LEAD_FIRST = 0xD800 };
enum { SURROGATE_LEAD_LAST = 0xDBFF };
enum { SURROGATE_TRAIL_FIRST = 0xDC00 };
enum { SURROGATE_TRAIL_LAST = 0xDFFF };
enum { SURROGATE_FIRST_VALUE = 0x10000 };
enum eState { eStart, eSecondOf4Bytes, ePenultimate, eFinal };
int nCur16 = 0;
int nCur = 0;
ubyte* pRead = reinterpret_cast