diff --git a/appveyor.yml b/appveyor.yml index 866f8df2e1..0b0b6cef81 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -95,7 +95,7 @@ build_script: #---------------------------------# artifacts: - path: 'sonar-cxx-plugin\target\*.jar' - - path: 'sslr-cxx-toolkit\target\*.jar' + - path: 'cxx-sslr-toolkit\target\*.jar' #---------------------------------# # global handlers # diff --git a/cxx-checks/pom.xml b/cxx-checks/pom.xml index 4fe6512665..c86bf85a9e 100644 --- a/cxx-checks/pom.xml +++ b/cxx-checks/pom.xml @@ -27,6 +27,11 @@ cxx-squid ${project.version} + + ${project.groupId} + cxx-squid-bridge + ${project.version} + commons-io commons-io diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/api/UndocumentedApiCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/api/UndocumentedApiCheck.java index cc8375c2dc..6f2e9a1f43 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/api/UndocumentedApiCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/api/UndocumentedApiCheck.java @@ -30,8 +30,8 @@ import org.sonar.check.Rule; import org.sonar.cxx.tag.Tag; import org.sonar.cxx.visitors.AbstractCxxPublicApiVisitor; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; /** * Check that generates issue for undocumented API items.
diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/error/ParsingErrorCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/error/ParsingErrorCheck.java index 19e7c8e900..6fed417a20 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/error/ParsingErrorCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/error/ParsingErrorCheck.java @@ -26,10 +26,10 @@ import org.sonar.check.Priority; import org.sonar.check.Rule; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.AstScannerExceptionHandler; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.NoSqale; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.AstScannerExceptionHandler; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.NoSqale; +import org.sonar.cxx.squidbridge.checks.SquidCheck; @Rule( key = "ParsingError", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/error/ParsingErrorRecoveryCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/error/ParsingErrorRecoveryCheck.java index 62c29fb238..05e286dec9 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/error/ParsingErrorRecoveryCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/error/ParsingErrorRecoveryCheck.java @@ -25,9 +25,9 @@ import org.sonar.check.Rule; import org.sonar.cxx.parser.CxxGrammarImpl; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.NoSqale; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.NoSqale; +import org.sonar.cxx.squidbridge.checks.SquidCheck; @Rule( key = "ParsingErrorRecovery", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/file/FileEncodingCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/file/FileEncodingCheck.java index aa10c526a0..d10c3b754d 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/file/FileEncodingCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/file/FileEncodingCheck.java @@ -27,10 +27,10 @@ import java.nio.file.Files; import org.sonar.check.Priority; import org.sonar.check.Rule; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.NoSqale; +import org.sonar.cxx.squidbridge.checks.SquidCheck; import org.sonar.cxx.visitors.CxxCharsetAwareVisitor; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.NoSqale; -import org.sonar.squidbridge.checks.SquidCheck; /** * FileEncodingCheck @@ -53,7 +53,7 @@ public void setCharset(Charset charset) { @Override public void visitFile(AstNode astNode) { try { - Files.readAllLines(getContext().getFile().toPath(), charset); + Files.readAllLines(getContext().getInputFile().file().toPath(), charset); } catch (IOException e) { getContext().createFileViolation(this, "Not all characters of the file can be encoded with the predefined charset " diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/file/MissingNewLineAtEndOfFileCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/file/MissingNewLineAtEndOfFileCheck.java index 421b756770..61a3780bd9 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/file/MissingNewLineAtEndOfFileCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/file/MissingNewLineAtEndOfFileCheck.java @@ -21,14 +21,12 @@ import com.sonar.sslr.api.AstNode; import com.sonar.sslr.api.Grammar; -import java.io.IOException; -import java.io.RandomAccessFile; import org.sonar.check.Priority; import org.sonar.check.Rule; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.SquidCheck; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.SquidCheck; @Rule( key = "MissingNewLineAtEndOfFile", @@ -39,24 +37,19 @@ @SqaleConstantRemediation("1min") public class MissingNewLineAtEndOfFileCheck extends SquidCheck { - private static boolean endsWithNewline(RandomAccessFile randomAccessFile) throws IOException { - if (randomAccessFile.length() < 1) { - return false; + @Override + public void visitFile(AstNode astNode) { + if (isEmptyOrNotEndingWithNewLine(getContext().getInputFileContent())) { + getContext().createFileViolation(this, "Add a new line at the end of this file."); } - randomAccessFile.seek(randomAccessFile.length() - 1); - byte lastByte = randomAccessFile.readByte(); - return lastByte == '\n' || lastByte == '\r'; } - @Override - public void visitFile(AstNode astNode) { - try (var randomAccessFile = new RandomAccessFile(getContext().getFile(), "r")) { - if (!endsWithNewline(randomAccessFile)) { - getContext().createFileViolation(this, "Add a new line at the end of this file."); - } - } catch (IOException e) { - throw new IllegalStateException(e); + private static boolean isEmptyOrNotEndingWithNewLine(String content) { + if (content.isEmpty()) { + return true; } + char lastChar = content.charAt(content.length() - 1); + return lastChar != '\n' && lastChar != '\r'; } } diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/file/TabCharacterCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/file/TabCharacterCheck.java index b12a816727..a3761a6054 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/file/TabCharacterCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/file/TabCharacterCheck.java @@ -21,19 +21,13 @@ import com.sonar.sslr.api.AstNode; import com.sonar.sslr.api.Grammar; -import java.io.BufferedReader; -import java.io.IOException; -import java.nio.charset.Charset; -import java.nio.charset.StandardCharsets; import org.sonar.check.Priority; import org.sonar.check.Rule; import org.sonar.check.RuleProperty; -import org.sonar.cxx.checks.utils.CheckUtils; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.SquidCheck; import org.sonar.cxx.tag.Tag; -import org.sonar.cxx.visitors.CxxCharsetAwareVisitor; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.SquidCheck; /** * TabCharacterCheck - similar Vera++ rule L002 "Don't use tab characters" @@ -46,7 +40,7 @@ priority = Priority.MINOR) @ActivatedByDefault @SqaleConstantRemediation("5min") -public class TabCharacterCheck extends SquidCheck implements CxxCharsetAwareVisitor { +public class TabCharacterCheck extends SquidCheck { private static final boolean DEFAULT_CREATE_LINE_VIOLATION = false; @@ -58,36 +52,24 @@ public class TabCharacterCheck extends SquidCheck implements CxxCharset description = "Create violations per line (default is one per file)", defaultValue = "" + DEFAULT_CREATE_LINE_VIOLATION) public boolean createLineViolation = DEFAULT_CREATE_LINE_VIOLATION; - private Charset defaultCharset = StandardCharsets.UTF_8; - - @Override - public void setCharset(Charset charset) { - this.defaultCharset = charset; - } @Override public void visitFile(AstNode astNode) { - try ( var br = new BufferedReader(CheckUtils.getInputSteam(getContext().getFile(), defaultCharset))) { - String line; - int nr = 0; - - while ((line = br.readLine()) != null) { - ++nr; - if (line.contains("\t")) { - if (createLineViolation) { - getContext().createLineViolation( - this, - "Replace all tab characters in this line by sequences of white-spaces.", nr); - } else { - getContext().createFileViolation( - this, - "Replace all tab characters in this file by sequences of white-spaces."); - break; - } + int nr = 0; + for (String line : getContext().getInputFileLines()) { + ++nr; + if (line.contains("\t")) { + if (createLineViolation) { + getContext().createLineViolation( + this, + "Replace all tab characters in this line by sequences of white-spaces.", nr); + } else { + getContext().createFileViolation( + this, + "Replace all tab characters in this file by sequences of white-spaces."); + break; } } - } catch (IOException e) { - throw new IllegalStateException(e); } } diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/ClassComplexityCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/ClassComplexityCheck.java index ae5c462806..6a0c6f0014 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/ClassComplexityCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/ClassComplexityCheck.java @@ -27,7 +27,7 @@ import org.sonar.check.RuleProperty; import org.sonar.cxx.parser.CxxGrammarImpl; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.SqaleLinearWithOffsetRemediation; +import org.sonar.cxx.squidbridge.annotations.SqaleLinearWithOffsetRemediation; @Rule( key = "ClassComplexity", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/CxxCyclomaticComplexityCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/CxxCyclomaticComplexityCheck.java index 3b55ad66a5..fc6588de3c 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/CxxCyclomaticComplexityCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/CxxCyclomaticComplexityCheck.java @@ -31,7 +31,7 @@ import org.sonar.cxx.visitors.MultiLocatitionSquidCheck; /** - * This is an enhanced version of org.sonar.squidbridge.metrics.ComplexityVisitor, which is used in order to compute the + * This is an enhanced version of org.sonar.cxx.squidbridge.metrics.ComplexityVisitor, which is used in order to compute the * Cyclomatic Complexity. * * @param diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FileComplexityCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FileComplexityCheck.java index e6c2cc1fc1..4889f9b6cf 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FileComplexityCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FileComplexityCheck.java @@ -26,7 +26,7 @@ import org.sonar.check.Rule; import org.sonar.check.RuleProperty; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.SqaleLinearWithOffsetRemediation; +import org.sonar.cxx.squidbridge.annotations.SqaleLinearWithOffsetRemediation; @Rule( key = "FileComplexity", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FunctionCognitiveComplexityCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FunctionCognitiveComplexityCheck.java index 3e555ece64..d8217c2121 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FunctionCognitiveComplexityCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FunctionCognitiveComplexityCheck.java @@ -27,8 +27,8 @@ import org.sonar.cxx.utils.CxxReportIssue; import org.sonar.cxx.visitors.CxxCognitiveComplexityVisitor; import org.sonar.cxx.visitors.CxxComplexityScope; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleLinearWithOffsetRemediation; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleLinearWithOffsetRemediation; @Rule( key = "FunctionCognitiveComplexity", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FunctionComplexityCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FunctionComplexityCheck.java index 9840abf106..8b450cd7d9 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FunctionComplexityCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/FunctionComplexityCheck.java @@ -27,8 +27,8 @@ import org.sonar.check.RuleProperty; import org.sonar.cxx.parser.CxxGrammarImpl; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleLinearWithOffsetRemediation; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleLinearWithOffsetRemediation; @Rule( key = "FunctionComplexity", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooLongLineCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooLongLineCheck.java index 5544a7f483..650409af19 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooLongLineCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooLongLineCheck.java @@ -21,19 +21,13 @@ import com.sonar.sslr.api.AstNode; import com.sonar.sslr.api.Grammar; -import java.io.BufferedReader; -import java.io.IOException; -import java.nio.charset.Charset; -import java.nio.charset.StandardCharsets; import org.sonar.check.Priority; import org.sonar.check.Rule; import org.sonar.check.RuleProperty; -import org.sonar.cxx.checks.utils.CheckUtils; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.SquidCheck; import org.sonar.cxx.tag.Tag; -import org.sonar.cxx.visitors.CxxCharsetAwareVisitor; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.SquidCheck; /** * TooLongLineCheck - similar Vera++ rule L004 "Line too long" @@ -46,7 +40,7 @@ priority = Priority.MINOR) @ActivatedByDefault @SqaleConstantRemediation("5min") -public class TooLongLineCheck extends SquidCheck implements CxxCharsetAwareVisitor { +public class TooLongLineCheck extends SquidCheck { private static final int DEFAULT_MAXIMUM_LINE_LENHGTH = 160; private static final int DEFAULT_TAB_WIDTH = 8; @@ -69,32 +63,19 @@ public class TooLongLineCheck extends SquidCheck implements CxxCharsetA defaultValue = "" + DEFAULT_TAB_WIDTH) public int tabWidth = DEFAULT_TAB_WIDTH; - private Charset defaultCharset = StandardCharsets.UTF_8; - - @Override - public void setCharset(Charset charset) { - this.defaultCharset = charset; - } - @Override public void visitFile(AstNode astNode) { - try ( var br = new BufferedReader(CheckUtils.getInputSteam(getContext().getFile(), defaultCharset))) { - String line; - int nr = 0; - - while ((line = br.readLine()) != null) { - ++nr; - long length = line.chars().filter(c -> c == '\t').count(); - length = line.length() + length * (tabWidth - 1); - if (length > maximumLineLength) { - getContext().createLineViolation( - this, - "Split this {0} characters long line (which is greater than {1} authorized).", - nr, length, maximumLineLength); - } + int nr = 0; + for (String line : getContext().getInputFileLines()) { + ++nr; + long length = line.chars().filter(c -> c == '\t').count(); + length = line.length() + length * (tabWidth - 1); + if (length > maximumLineLength) { + getContext().createLineViolation( + this, + "Split this {0} characters long line (which is greater than {1} authorized).", + nr, length, maximumLineLength); } - } catch (IOException e) { - throw new IllegalStateException(e); } } diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFileCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFileCheck.java index 92bca22ecd..3ae3ce3b9e 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFileCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFileCheck.java @@ -26,10 +26,10 @@ import org.sonar.check.RuleProperty; import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.ChecksHelper; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.ChecksHelper; +import org.sonar.cxx.squidbridge.checks.SquidCheck; @Rule( key = "TooManyLinesOfCodeInFile", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFunctionCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFunctionCheck.java index ca29757624..3a7653633b 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFunctionCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFunctionCheck.java @@ -27,10 +27,10 @@ import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.parser.CxxGrammarImpl; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.api.SourceFunction; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.api.SourceFunction; +import org.sonar.cxx.squidbridge.checks.SquidCheck; @Rule(key = "TooManyLinesOfCodeInFunction", name = "Avoid too many code lines in a single function", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyParametersCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyParametersCheck.java index 61627165e6..a1e4467b1b 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyParametersCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyParametersCheck.java @@ -26,9 +26,9 @@ import org.sonar.check.RuleProperty; import org.sonar.cxx.parser.CxxGrammarImpl; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.SquidCheck; @Rule( key = "TooManyParameters", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyStatementsPerLineCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyStatementsPerLineCheck.java index 732d07e872..7acfe3e150 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyStatementsPerLineCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/metrics/TooManyStatementsPerLineCheck.java @@ -28,9 +28,9 @@ import org.sonar.cxx.parser.CxxGrammarImpl; import org.sonar.cxx.parser.CxxKeyword; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.AbstractOneStatementPerLineCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.AbstractOneStatementPerLineCheck; /** * TooManyStatementsPerLineCheck - Statements should be on separate lines diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/ClassNameCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/ClassNameCheck.java index b8c0b4a7af..bcf2ef4f68 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/ClassNameCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/ClassNameCheck.java @@ -28,9 +28,9 @@ import org.sonar.cxx.checks.utils.CheckUtils; import org.sonar.cxx.parser.CxxGrammarImpl; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.SquidCheck; /** * ClassNameCheck diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/FileNameCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/FileNameCheck.java index dda1907591..0c2c36d4fa 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/FileNameCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/FileNameCheck.java @@ -27,9 +27,9 @@ import org.sonar.check.Rule; import org.sonar.check.RuleProperty; import org.sonar.cxx.checks.utils.CheckUtils; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.SquidCheck; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.SquidCheck; /** * FileNameCheck @@ -62,7 +62,7 @@ public void init() { @Override public void visitFile(@Nullable AstNode astNode) { - String fileName = getContext().getFile().getName(); + String fileName = getContext().getInputFile().filename(); int dotIndex = fileName.lastIndexOf('.'); if (dotIndex > 0) { String moduleName = fileName.substring(0, dotIndex); diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/FunctionNameCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/FunctionNameCheck.java index 6aec6d9e92..82dec857fa 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/FunctionNameCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/FunctionNameCheck.java @@ -29,9 +29,9 @@ import org.sonar.cxx.checks.utils.CheckUtils; import org.sonar.cxx.parser.CxxGrammarImpl; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.SquidCheck; /** * FunctionNameCheck diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/MethodNameCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/MethodNameCheck.java index 58d1e3e821..c7db0fa1e3 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/MethodNameCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/naming/MethodNameCheck.java @@ -33,9 +33,9 @@ import static org.sonar.cxx.checks.utils.CheckUtils.isFunctionDefinition; import org.sonar.cxx.parser.CxxGrammarImpl; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.SquidCheck; /** * MethodNameCheck diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/CommentContainsPatternChecker.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/CommentContainsPatternChecker.java index 84d659591b..50c9bbdd76 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/CommentContainsPatternChecker.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/CommentContainsPatternChecker.java @@ -22,7 +22,7 @@ import com.sonar.sslr.api.Token; import java.util.regex.Matcher; import java.util.regex.Pattern; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.checks.SquidCheck; class CommentContainsPatternChecker { diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/CommentRegularExpressionCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/CommentRegularExpressionCheck.java index 8f40dac8df..7e2d08739e 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/CommentRegularExpressionCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/CommentRegularExpressionCheck.java @@ -23,9 +23,9 @@ import org.sonar.check.Priority; import org.sonar.check.Rule; import org.sonar.check.RuleProperty; -import org.sonar.squidbridge.annotations.NoSqale; -import org.sonar.squidbridge.annotations.RuleTemplate; -import org.sonar.squidbridge.checks.AbstractCommentRegularExpressionCheck; +import org.sonar.cxx.squidbridge.annotations.NoSqale; +import org.sonar.cxx.squidbridge.annotations.RuleTemplate; +import org.sonar.cxx.squidbridge.checks.AbstractCommentRegularExpressionCheck; @Rule( key = "CommentRegularExpression", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FileHeaderCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FileHeaderCheck.java index 66a4d6c434..d3f413c934 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FileHeaderCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FileHeaderCheck.java @@ -21,20 +21,17 @@ import com.sonar.sslr.api.AstNode; import com.sonar.sslr.api.Grammar; -import java.io.BufferedReader; -import java.io.IOException; -import java.nio.charset.Charset; -import java.nio.charset.StandardCharsets; +import java.util.Iterator; +import java.util.List; import java.util.regex.Matcher; import java.util.regex.Pattern; import org.sonar.check.Priority; import org.sonar.check.Rule; import org.sonar.check.RuleProperty; import org.sonar.cxx.checks.utils.CheckUtils; -import org.sonar.cxx.visitors.CxxCharsetAwareVisitor; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.SquidCheck; /** * FileHeaderCheck - similar Vera++ rule T013 "No copyright notice found" @@ -47,7 +44,7 @@ tags = {}) @ActivatedByDefault @SqaleConstantRemediation("5min") -public class FileHeaderCheck extends SquidCheck implements CxxCharsetAwareVisitor { +public class FileHeaderCheck extends SquidCheck { private static final String DEFAULT_HEADER_FORMAT = ""; private static final String MESSAGE = "Add or update the header of this file."; @@ -71,25 +68,9 @@ public class FileHeaderCheck extends SquidCheck implements CxxCharsetAw defaultValue = "false") public boolean isRegularExpression = false; - private Charset defaultCharset = StandardCharsets.UTF_8; private String[] expectedLines = null; private Pattern searchPattern = null; - private static boolean matches(String[] expectedLines, BufferedReader br) throws IOException { - for (var expectedLine : expectedLines) { - var line = br.readLine(); - if (!expectedLine.equals(line)) { - return false; - } - } - return true; - } - - @Override - public void setCharset(Charset charset) { - this.defaultCharset = charset; - } - @Override public void init() { if (isRegularExpression) { @@ -97,25 +78,19 @@ public void init() { searchPattern = CheckUtils.compileUserRegexp(getHeaderFormat(), Pattern.DOTALL); } } else { - expectedLines = headerFormat.split("\\R"); + expectedLines = headerFormat.split("(?:\r)?\n|\r"); } } @Override public void visitFile(AstNode astNode) { - try { - if (isRegularExpression) { - String fileContent = CheckUtils.getFileContent(getContext().getFile(), defaultCharset); - checkRegularExpression(fileContent); - } else { - try ( var br = new BufferedReader(CheckUtils.getInputSteam(getContext().getFile(), defaultCharset))) { - if (!matches(expectedLines, br)) { - getContext().createFileViolation(this, MESSAGE); - } - } + if (isRegularExpression) { + String fileContent = getContext().getInputFileContent(); + checkRegularExpression(fileContent); + } else { + if (!matches(expectedLines, getContext().getInputFileLines())) { + getContext().createFileViolation(this, MESSAGE); } - } catch (IOException e) { - throw new IllegalStateException(e); } } @@ -134,4 +109,23 @@ private void checkRegularExpression(String fileContent) { } } + private static boolean matches(String[] expectedLines, List lines) { + boolean result = false; + + if (expectedLines.length <= lines.size()) { + result = true; + + Iterator it = lines.iterator(); + for (int i = 0; i < expectedLines.length; i++) { + String line = it.next(); + if (!line.equals(expectedLines[i])) { + result = false; + break; + } + } + } + + return result; + } + } diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FileRegularExpressionCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FileRegularExpressionCheck.java index 5cf1fab592..9ea995af82 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FileRegularExpressionCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FileRegularExpressionCheck.java @@ -21,9 +21,6 @@ import com.sonar.sslr.api.AstNode; import com.sonar.sslr.api.Grammar; -import java.io.IOException; -import java.nio.charset.Charset; -import java.nio.charset.StandardCharsets; import java.util.regex.Matcher; import java.util.regex.Pattern; import org.sonar.api.utils.PathUtils; @@ -32,10 +29,9 @@ import org.sonar.check.Rule; import org.sonar.check.RuleProperty; import org.sonar.cxx.checks.utils.CheckUtils; -import org.sonar.cxx.visitors.CxxCharsetAwareVisitor; -import org.sonar.squidbridge.annotations.NoSqale; -import org.sonar.squidbridge.annotations.RuleTemplate; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.NoSqale; +import org.sonar.cxx.squidbridge.annotations.RuleTemplate; +import org.sonar.cxx.squidbridge.checks.SquidCheck; /** * FileRegularExpressionCheck @@ -47,7 +43,7 @@ priority = Priority.MAJOR) @RuleTemplate @NoSqale -public class FileRegularExpressionCheck extends SquidCheck implements CxxCharsetAwareVisitor { +public class FileRegularExpressionCheck extends SquidCheck { private static final String DEFAULT_MATCH_FILE_PATTERN = ""; private static final boolean DEFAULT_INVERT_FILE_PATTERN = false; @@ -99,7 +95,6 @@ public class FileRegularExpressionCheck extends SquidCheck implements C description = "The violation message", defaultValue = DEFAULT_MESSAGE) public String message = DEFAULT_MESSAGE; - private Charset defaultCharset = StandardCharsets.UTF_8; private Pattern pattern = null; private static boolean compare(boolean invert, boolean condition) { @@ -111,33 +106,24 @@ public void init() { pattern = CheckUtils.compileUserRegexp(regularExpression); } - @Override - public void setCharset(Charset charset) { - this.defaultCharset = charset; - } - @Override public void visitFile(AstNode fileNode) { if (!compare(invertFilePattern, matchFile())) { return; } - try { - String fileContent = CheckUtils.getFileContent(getContext().getFile(), defaultCharset); - Matcher matcher = pattern.matcher(fileContent); + String fileContent = getContext().getInputFileContent(); + Matcher matcher = pattern.matcher(fileContent); - if (compare(invertRegularExpression, matcher.find())) { - getContext().createFileViolation(this, message); - } - } catch (IOException e) { - throw new IllegalStateException(e); + if (compare(invertRegularExpression, matcher.find())) { + getContext().createFileViolation(this, message); } } private boolean matchFile() { if (!matchFilePattern.isEmpty()) { WildcardPattern filePattern = WildcardPattern.create(matchFilePattern); - String path = PathUtils.sanitize(getContext().getFile().getPath()); + String path = PathUtils.sanitize(getContext().getInputFile().file().getPath()); return path != null ? filePattern.match(path) : false; } return true; diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FixmeTagPresenceCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FixmeTagPresenceCheck.java index e068a3a1bd..65df6c75b8 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FixmeTagPresenceCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/FixmeTagPresenceCheck.java @@ -25,9 +25,9 @@ import org.sonar.check.Priority; import org.sonar.check.Rule; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.SquidCheck; @Rule( key = "FixmeTagPresence", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/LineRegularExpressionCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/LineRegularExpressionCheck.java index 074d4025d7..867c664831 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/LineRegularExpressionCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/LineRegularExpressionCheck.java @@ -21,10 +21,6 @@ import com.sonar.sslr.api.AstNode; import com.sonar.sslr.api.Grammar; -import java.io.BufferedReader; -import java.io.IOException; -import java.nio.charset.Charset; -import java.nio.charset.StandardCharsets; import java.util.regex.Matcher; import java.util.regex.Pattern; import org.sonar.api.utils.PathUtils; @@ -33,10 +29,9 @@ import org.sonar.check.Rule; import org.sonar.check.RuleProperty; import org.sonar.cxx.checks.utils.CheckUtils; -import org.sonar.cxx.visitors.CxxCharsetAwareVisitor; -import org.sonar.squidbridge.annotations.NoSqale; -import org.sonar.squidbridge.annotations.RuleTemplate; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.NoSqale; +import org.sonar.cxx.squidbridge.annotations.RuleTemplate; +import org.sonar.cxx.squidbridge.checks.SquidCheck; /** * LineRegularExpressionCheck @@ -48,7 +43,7 @@ priority = Priority.MAJOR) @RuleTemplate @NoSqale -public class LineRegularExpressionCheck extends SquidCheck implements CxxCharsetAwareVisitor { +public class LineRegularExpressionCheck extends SquidCheck { private static final String DEFAULT_MATCH_FILE_PATTERN = ""; private static final boolean DEFAULT_INVERT_FILE_PATTERN = false; @@ -100,7 +95,6 @@ public class LineRegularExpressionCheck extends SquidCheck implements C description = "The violation message", defaultValue = DEFAULT_MESSAGE) public String message = DEFAULT_MESSAGE; - private Charset defaultCharset = StandardCharsets.UTF_8; private Pattern pattern = null; private static boolean compare(boolean invert, boolean condition) { @@ -112,29 +106,16 @@ public void init() { pattern = CheckUtils.compileUserRegexp(regularExpression); } - @Override - public void setCharset(Charset charset) { - this.defaultCharset = charset; - } - @Override public void visitFile(AstNode fileNode) { if (compare(invertFilePattern, matchFile())) { - - // use onMalformedInput(CodingErrorAction.REPLACE) / onUnmappableCharacter(CodingErrorAction.REPLACE) - try ( var br = new BufferedReader(CheckUtils.getInputSteam(getContext().getFile(), defaultCharset))) { - String line; - int nr = 0; - - while ((line = br.readLine()) != null) { - Matcher matcher = pattern.matcher(line); - ++nr; - if (compare(invertRegularExpression, matcher.find())) { - getContext().createLineViolation(this, message, nr); - } + int nr = 0; + for (String line : getContext().getInputFileLines()) { + Matcher matcher = pattern.matcher(line); + ++nr; + if (compare(invertRegularExpression, matcher.find())) { + getContext().createLineViolation(this, message, nr); } - } catch (IOException e) { - throw new IllegalStateException(e); } } } @@ -142,7 +123,7 @@ public void visitFile(AstNode fileNode) { private boolean matchFile() { if (!matchFilePattern.isEmpty()) { WildcardPattern filePattern = WildcardPattern.create(matchFilePattern); - String path = PathUtils.sanitize(getContext().getFile().getPath()); + String path = PathUtils.sanitize(getContext().getInputFile().file().getPath()); return path != null ? filePattern.match(path) : false; } return true; diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/NoSonarCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/NoSonarCheck.java index 7ca6f6d707..9ecee86361 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/NoSonarCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/NoSonarCheck.java @@ -25,9 +25,9 @@ import java.util.regex.Pattern; import org.sonar.check.Priority; import org.sonar.check.Rule; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.NoSqale; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.NoSqale; +import org.sonar.cxx.squidbridge.checks.SquidCheck; /** * Note that {@link com.sonar.sslr.squid.checks.AbstractNoSonarCheck} can't be used because of bug SSLRSQBR-16. diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/TodoTagPresenceCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/TodoTagPresenceCheck.java index 25b4501cf1..827ff2087f 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/TodoTagPresenceCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/regex/TodoTagPresenceCheck.java @@ -25,9 +25,9 @@ import org.sonar.check.Priority; import org.sonar.check.Rule; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.annotations.ActivatedByDefault; -import org.sonar.squidbridge.annotations.SqaleConstantRemediation; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.annotations.ActivatedByDefault; +import org.sonar.cxx.squidbridge.annotations.SqaleConstantRemediation; +import org.sonar.cxx.squidbridge.checks.SquidCheck; @Rule( key = "TodoTagPresence", diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/utils/CheckUtils.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/utils/CheckUtils.java index 4d74aed737..aab1d3f974 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/utils/CheckUtils.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/utils/CheckUtils.java @@ -21,20 +21,9 @@ import com.sonar.sslr.api.AstNode; import com.sonar.sslr.api.GenericTokenType; -import java.io.File; -import java.io.FileInputStream; -import java.io.IOException; -import java.io.InputStreamReader; -import java.nio.charset.Charset; -import java.util.ArrayList; -import java.util.List; import java.util.Objects; -import java.util.Scanner; import java.util.regex.Pattern; import java.util.regex.PatternSyntaxException; -import java.util.stream.Collectors; -import org.apache.commons.io.ByteOrderMark; -import org.apache.commons.io.input.BOMInputStream; import org.sonar.cxx.parser.CxxGrammarImpl; import org.sonar.cxx.parser.CxxKeyword; import org.sonar.cxx.parser.CxxPunctuator; @@ -97,38 +86,4 @@ public static boolean isFunctionDefinition(AstNode node) { return false; } - public static List getFileLines(File source, Charset defaultCharset) throws IOException { - List lines = new ArrayList<>(); - try ( Scanner scanner = new Scanner(getInputSteam(source, defaultCharset))) { - while (scanner.hasNextLine()) { - lines.add(scanner.nextLine()); - } - } - return lines; - } - - public static String getFileContent(File source, Charset defaultCharset) throws IOException { - return getFileLines(source, defaultCharset).stream().collect(Collectors.joining(System.lineSeparator())); - } - - public static InputStreamReader getInputSteam(File source, Charset defaultCharset) throws IOException { - BOMInputStream bomInputStream = null; - try { - bomInputStream = new BOMInputStream(new FileInputStream(source), - ByteOrderMark.UTF_8, - ByteOrderMark.UTF_16LE, - ByteOrderMark.UTF_16BE, - ByteOrderMark.UTF_32LE, - ByteOrderMark.UTF_32BE); - ByteOrderMark bom = bomInputStream.getBOM(); - Charset charset = bom != null ? Charset.forName(bom.getCharsetName()) : defaultCharset; - return new InputStreamReader(bomInputStream, charset); - } catch (IOException e) { - if (bomInputStream != null) { - bomInputStream.close(); - } - throw e; - } - } - } diff --git a/cxx-checks/src/main/java/org/sonar/cxx/checks/xpath/XPathCheck.java b/cxx-checks/src/main/java/org/sonar/cxx/checks/xpath/XPathCheck.java index 325c666e17..0c0de57f2c 100644 --- a/cxx-checks/src/main/java/org/sonar/cxx/checks/xpath/XPathCheck.java +++ b/cxx-checks/src/main/java/org/sonar/cxx/checks/xpath/XPathCheck.java @@ -26,9 +26,9 @@ import org.sonar.check.Priority; import org.sonar.check.Rule; import org.sonar.check.RuleProperty; -import org.sonar.squidbridge.annotations.NoSqale; -import org.sonar.squidbridge.annotations.RuleTemplate; -import org.sonar.squidbridge.checks.AbstractXPathCheck; +import org.sonar.cxx.squidbridge.annotations.NoSqale; +import org.sonar.cxx.squidbridge.annotations.RuleTemplate; +import org.sonar.cxx.squidbridge.checks.AbstractXPathCheck; @Rule( key = "XPath", @@ -86,7 +86,7 @@ public String getMessage() { public void visitFile(AstNode fileNode) { if (!matchFilePattern.isEmpty()) { WildcardPattern pattern = WildcardPattern.create(matchFilePattern); - String path = PathUtils.sanitize(getContext().getFile().getPath()); + String path = PathUtils.sanitize(getContext().getInputFile().file().getPath()); if (!compare(invertFilePattern, pattern.match(path))) { return; } diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/CxxFileTester.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/CxxFileTester.java index 0c34ee38c1..df0c6f31db 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/CxxFileTester.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/CxxFileTester.java @@ -19,7 +19,6 @@ */ package org.sonar.cxx.checks; -import java.io.File; import org.sonar.api.batch.fs.InputFile; import org.sonar.api.batch.sensor.internal.SensorContextTester; @@ -28,8 +27,8 @@ public class CxxFileTester { public InputFile cxxFile; public SensorContextTester context; - public File asFile() { - return new File(cxxFile.uri().getPath()); + public InputFile asInputFile() { + return cxxFile; } } diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/CxxFileTesterHelper.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/CxxFileTesterHelper.java index a029fff616..c5eb6325e9 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/CxxFileTesterHelper.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/CxxFileTesterHelper.java @@ -20,40 +20,60 @@ package org.sonar.cxx.checks; import java.io.File; +import java.io.FileInputStream; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; +import java.nio.file.Paths; +import org.apache.commons.io.ByteOrderMark; +import org.apache.commons.io.input.BOMInputStream; +import org.sonar.api.batch.fs.internal.DefaultInputFile; import org.sonar.api.batch.fs.internal.TestInputFileBuilder; import org.sonar.api.batch.sensor.internal.SensorContextTester; -/** - * - * @author jocs - */ public class CxxFileTesterHelper { - public static CxxFileTester CreateCxxFileTester(String fileName, String basePath) throws UnsupportedEncodingException, - IOException { + private CxxFileTesterHelper() { + // utility class + } + + public static CxxFileTester create(String fileName, String basePath) + throws UnsupportedEncodingException, IOException { + return create(fileName, basePath, Charset.defaultCharset()); + } + + public static CxxFileTester create(String fileName, String basePath, Charset charset) + throws UnsupportedEncodingException, IOException { var tester = new CxxFileTester(); - tester.context = SensorContextTester.create(new File(basePath)); - tester.context.fileSystem().add(TestInputFileBuilder.create("", fileName).build()); - tester.cxxFile = tester.context.fileSystem().inputFile(tester.context.fileSystem().predicates().hasPath( - fileName)); + tester.context = SensorContextTester.create(new File(basePath)); + tester.cxxFile = createInputFile(fileName, basePath, charset); + tester.context.fileSystem().add(tester.cxxFile); return tester; } - public static CxxFileTester CreateCxxFileTester(String fileName, String basePath, Charset charset) throws - UnsupportedEncodingException, IOException { - var tester = new CxxFileTester(); - tester.context = SensorContextTester.create(new File(basePath)); + private static DefaultInputFile createInputFile(String fileName, String basePath, Charset charset) throws IOException { + TestInputFileBuilder fb = TestInputFileBuilder.create("", fileName); - tester.context.fileSystem().add(TestInputFileBuilder.create("", fileName).setCharset(charset).build()); - tester.cxxFile = tester.context.fileSystem().inputFile(tester.context.fileSystem().predicates().hasPath( - fileName)); + fb.setCharset(charset); + fb.setProjectBaseDir(Paths.get(basePath)); + fb.setContents(getSourceCode(Paths.get(basePath, fileName).toFile(), charset)); - return tester; + return fb.build(); } + private static String getSourceCode(File filename, Charset defaultCharset) throws IOException { + try ( BOMInputStream bomInputStream = new BOMInputStream(new FileInputStream(filename), + ByteOrderMark.UTF_8, + ByteOrderMark.UTF_16LE, + ByteOrderMark.UTF_16BE, + ByteOrderMark.UTF_32LE, + ByteOrderMark.UTF_32BE)) { + ByteOrderMark bom = bomInputStream.getBOM(); + Charset charset = bom != null ? Charset.forName(bom.getCharsetName()) : defaultCharset; + byte[] bytes = bomInputStream.readAllBytes(); + return new String(bytes, charset); + } + } } diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/api/UndocumentedApiCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/api/UndocumentedApiCheckTest.java index 453e7b96e7..6f59317e3d 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/api/UndocumentedApiCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/api/UndocumentedApiCheckTest.java @@ -25,10 +25,9 @@ import org.junit.Rule; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; -import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifierRule; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifierRule; public class UndocumentedApiCheckTest { @@ -38,9 +37,8 @@ public class UndocumentedApiCheckTest { @SuppressWarnings("squid:S2699") @Test public void detected() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester( - "src/test/resources/checks/UndocumentedApiCheck/no_doc.h", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), new UndocumentedApiCheck()); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/UndocumentedApiCheck/no_doc.h", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), new UndocumentedApiCheck()); checkMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(6) // class @@ -99,9 +97,8 @@ public void detected() throws UnsupportedEncodingException, IOException { @Test public void docStyle1() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester( - "src/test/resources/checks/UndocumentedApiCheck/doc_style1.h", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), new UndocumentedApiCheck()); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/UndocumentedApiCheck/doc_style1.h", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), new UndocumentedApiCheck()); var errors = new StringBuilder(1024); for (var msg : file.getCheckMessages()) { @@ -116,9 +113,8 @@ public void docStyle1() throws UnsupportedEncodingException, IOException { @Test public void docStyle2() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester( - "src/test/resources/checks/UndocumentedApiCheck/doc_style2.h", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), new UndocumentedApiCheck()); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/UndocumentedApiCheck/doc_style2.h", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), new UndocumentedApiCheck()); var errors = new StringBuilder(1024); for (var msg : file.getCheckMessages()) { diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/error/ParsingErrorCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/error/ParsingErrorCheckTest.java index 25fca1bdfe..b4f70bc017 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/error/ParsingErrorCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/error/ParsingErrorCheckTest.java @@ -24,11 +24,10 @@ import static org.hamcrest.Matchers.containsString; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; -import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; import org.sonar.cxx.config.CxxSquidConfiguration; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class ParsingErrorCheckTest { @@ -39,8 +38,9 @@ public void test_syntax_error_recognition() throws UnsupportedEncodingException, squidConfig.add(CxxSquidConfiguration.SONAR_PROJECT_PROPERTIES, CxxSquidConfiguration.ERROR_RECOVERY_ENABLED, "false"); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/parsingError1.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig, new ParsingErrorCheck()); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/parsingError1.cc", "."); + SourceFile file = CxxAstScanner + .scanSingleInputFileConfig(tester.asInputFile(), squidConfig, new ParsingErrorCheck()); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(4).withMessageThat(containsString("Parse error")) @@ -54,8 +54,9 @@ public void test_syntax_error_pperror() throws UnsupportedEncodingException, IOE squidConfig.add(CxxSquidConfiguration.SONAR_PROJECT_PROPERTIES, CxxSquidConfiguration.ERROR_RECOVERY_ENABLED, "false"); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/parsingError2.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig, new ParsingErrorCheck()); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/parsingError2.cc", "."); + SourceFile file = CxxAstScanner + .scanSingleInputFileConfig(tester.asInputFile(), squidConfig, new ParsingErrorCheck()); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(2).withMessageThat(containsString("Parse error")) diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/error/ParsingErrorRecoveryCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/error/ParsingErrorRecoveryCheckTest.java index d68ee83ce4..c348d9bdd8 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/error/ParsingErrorRecoveryCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/error/ParsingErrorRecoveryCheckTest.java @@ -23,11 +23,10 @@ import java.io.UnsupportedEncodingException; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; -import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; import org.sonar.cxx.config.CxxSquidConfiguration; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class ParsingErrorRecoveryCheckTest { @@ -38,8 +37,9 @@ public void test_syntax_error_recovery() throws UnsupportedEncodingException, IO squidConfig.add(CxxSquidConfiguration.SONAR_PROJECT_PROPERTIES, CxxSquidConfiguration.ERROR_RECOVERY_ENABLED, "true"); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/parsingError3.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig, new ParsingErrorRecoveryCheck()); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/parsingError3.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig, + new ParsingErrorRecoveryCheck()); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(2).withMessage("C++ Parser can't read code. Declaration is skipped.") diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/file/FileEncodingCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/file/FileEncodingCheckTest.java index e507890dbc..cb91e070ea 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/file/FileEncodingCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/file/FileEncodingCheckTest.java @@ -25,11 +25,10 @@ import java.nio.charset.StandardCharsets; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; -import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; import org.sonar.cxx.config.CxxSquidConfiguration; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class FileEncodingCheckTest { @@ -39,9 +38,8 @@ public class FileEncodingCheckTest { @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void testAsciiFileAsciiEncoding() throws UnsupportedEncodingException, IOException { var squidConfig = new CxxSquidConfiguration("", StandardCharsets.US_ASCII); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/TabCharacter.cc", ".", - StandardCharsets.US_ASCII); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig, check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/TabCharacter.cc", ".", StandardCharsets.US_ASCII); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig, check); CheckMessagesVerifier.verify(file.getCheckMessages()) .noMore(); @@ -51,9 +49,8 @@ public void testAsciiFileAsciiEncoding() throws UnsupportedEncodingException, IO @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void testAsciiFileUtf8Encoding() throws UnsupportedEncodingException, IOException { var squidConfig = new CxxSquidConfiguration("", StandardCharsets.UTF_8); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/TabCharacter.cc", ".", - StandardCharsets.UTF_8); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig, check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/TabCharacter.cc", ".", StandardCharsets.UTF_8); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig, check); CheckMessagesVerifier.verify(file.getCheckMessages()) .noMore(); @@ -63,9 +60,8 @@ public void testAsciiFileUtf8Encoding() throws UnsupportedEncodingException, IOE @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void testUnicodeFileUtf16Encoding() throws UnsupportedEncodingException, IOException { var squidConfig = new CxxSquidConfiguration("", StandardCharsets.UTF_16); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/Unicode.cc", ".", - StandardCharsets.UTF_16); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig, check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/Unicode.cc", ".", StandardCharsets.UTF_16); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig, check); CheckMessagesVerifier.verify(file.getCheckMessages()) .noMore(); } @@ -75,9 +71,8 @@ public void testUnicodeFileUtf16Encoding() throws UnsupportedEncodingException, public void testUnicodeFileAsciiEncoding() throws IOException { Charset charset = StandardCharsets.US_ASCII; var squidConfig = new CxxSquidConfiguration("", charset); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/Unicode.cc", ".", - charset); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig, check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/Unicode.cc", ".", charset); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig, check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().withMessage("Not all characters of the file can be encoded with the predefined charset " + charset.name() + ".") diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/file/MissingNewLineAtEndOfFileCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/file/MissingNewLineAtEndOfFileCheckTest.java index 53592e64a3..aac0b91acd 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/file/MissingNewLineAtEndOfFileCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/file/MissingNewLineAtEndOfFileCheckTest.java @@ -23,10 +23,9 @@ import java.io.UnsupportedEncodingException; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; -import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class MissingNewLineAtEndOfFileCheckTest { @@ -35,9 +34,8 @@ public class MissingNewLineAtEndOfFileCheckTest { @Test @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void test() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester( - "src/test/resources/checks/MissingNewLineAtEndOfFile.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/MissingNewLineAtEndOfFile.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().withMessage("Add a new line at the end of this file.") @@ -47,8 +45,8 @@ public void test() throws UnsupportedEncodingException, IOException { @Test @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void test2() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/EmptyFile.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/EmptyFile.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().withMessage("Add a new line at the end of this file.") .noMore(); @@ -57,8 +55,8 @@ public void test2() throws UnsupportedEncodingException, IOException { @Test @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void test3() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/NonEmptyFile.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/NonEmptyFile.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .noMore(); } diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/file/TabCharacterCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/file/TabCharacterCheckTest.java index 499e4ac245..673609d4ae 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/file/TabCharacterCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/file/TabCharacterCheckTest.java @@ -25,8 +25,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class TabCharacterCheckTest { @@ -37,8 +37,8 @@ public class TabCharacterCheckTest { public void fileWithTabsOneMessagePerFile() throws UnsupportedEncodingException, IOException { check.createLineViolation = false; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/TabCharacter.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/TabCharacter.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().withMessage("Replace all tab characters in this file by sequences of white-spaces.") @@ -49,8 +49,8 @@ public void fileWithTabsOneMessagePerFile() throws UnsupportedEncodingException, @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void fileWithTabsOneMessagePerLine() throws UnsupportedEncodingException, IOException { check.createLineViolation = true; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/TabCharacter.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/TabCharacter.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(3).withMessage("Replace all tab characters in this line by sequences of white-spaces.") @@ -62,8 +62,8 @@ public void fileWithTabsOneMessagePerLine() throws UnsupportedEncodingException, @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void fileWithoutTabs() throws UnsupportedEncodingException, IOException { check.createLineViolation = false; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/NonEmptyFile.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/NonEmptyFile.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .noMore(); diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/ClassComplexityCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/ClassComplexityCheckTest.java index 43c5a94726..04d0aea780 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/ClassComplexityCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/ClassComplexityCheckTest.java @@ -28,10 +28,10 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; +import org.sonar.cxx.squidbridge.api.SourceFile; import org.sonar.cxx.utils.CxxReportIssue; import org.sonar.cxx.utils.CxxReportLocation; import org.sonar.cxx.visitors.MultiLocatitionSquidCheck; -import org.sonar.squidbridge.api.SourceFile; public class ClassComplexityCheckTest { @@ -40,8 +40,8 @@ public void test() throws UnsupportedEncodingException, IOException { var check = new ClassComplexityCheck(); check.setMaxComplexity(5); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/ClassComplexity.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/ClassComplexity.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); Set issues = MultiLocatitionSquidCheck.getMultiLocationCheckMessages(file); assertThat(issues).isNotNull(); diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FileComplexityCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FileComplexityCheckTest.java index 6a595731b9..1810d791b5 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FileComplexityCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FileComplexityCheckTest.java @@ -28,10 +28,10 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; +import org.sonar.cxx.squidbridge.api.SourceFile; import org.sonar.cxx.utils.CxxReportIssue; import org.sonar.cxx.utils.CxxReportLocation; import org.sonar.cxx.visitors.MultiLocatitionSquidCheck; -import org.sonar.squidbridge.api.SourceFile; public class FileComplexityCheckTest { @@ -40,8 +40,8 @@ public void check() throws UnsupportedEncodingException, IOException { var check = new FileComplexityCheck(); check.setMaxComplexity(1); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/functions.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/functions.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); Set issues = MultiLocatitionSquidCheck.getMultiLocationCheckMessages(file); assertThat(issues).isNotNull(); @@ -53,8 +53,8 @@ public void check() throws UnsupportedEncodingException, IOException { softly.assertThat(actualIssue.getLocations()).containsOnly( new CxxReportLocation(null, "1", null, "The Cyclomatic Complexity of this file is 2 which is greater than 1 authorized."), - new CxxReportLocation(null, "3", null, "+1: function definition"), - new CxxReportLocation(null, "5", null, "+1: function definition") + new CxxReportLocation(null, "3", null, "+1: function definition"), + new CxxReportLocation(null, "5", null, "+1: function definition") ); softly.assertAll(); } diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FunctionCognitiveComplexityCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FunctionCognitiveComplexityCheckTest.java index db2cbabaa7..ef831a3357 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FunctionCognitiveComplexityCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FunctionCognitiveComplexityCheckTest.java @@ -26,12 +26,11 @@ import org.assertj.core.api.SoftAssertions; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; -import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; +import org.sonar.cxx.squidbridge.api.SourceFile; import org.sonar.cxx.utils.CxxReportIssue; import org.sonar.cxx.utils.CxxReportLocation; import org.sonar.cxx.visitors.MultiLocatitionSquidCheck; -import org.sonar.squidbridge.api.SourceFile; public class FunctionCognitiveComplexityCheckTest { @@ -39,9 +38,8 @@ public class FunctionCognitiveComplexityCheckTest { public void check() throws UnsupportedEncodingException, IOException { var check = new FunctionCognitiveComplexityCheck(); check.setMaxComplexity(5); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester( - "src/test/resources/checks/FunctionCognitiveComplexity.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/FunctionCognitiveComplexity.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); Set issues = MultiLocatitionSquidCheck.getMultiLocationCheckMessages(file); assertThat(issues).isNotNull(); diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FunctionComplexityCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FunctionComplexityCheckTest.java index 381a5f307d..dbd2371655 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FunctionComplexityCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/FunctionComplexityCheckTest.java @@ -35,8 +35,8 @@ public class FunctionComplexityCheckTest { public void check() throws UnsupportedEncodingException, IOException { var check = new FunctionComplexityCheck(); check.setMaxComplexity(5); - var tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FunctionComplexity.cc", "."); - var file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/FunctionComplexity.cc", "."); + var file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); var issues = MultiLocatitionSquidCheck.getMultiLocationCheckMessages(file); assertThat(issues).isNotNull(); var softly = new SoftAssertions(); diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooLongLineCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooLongLineCheckTest.java index 3c3f00efed..2973717a3e 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooLongLineCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooLongLineCheckTest.java @@ -25,8 +25,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class TooLongLineCheckTest { @@ -36,8 +36,8 @@ public class TooLongLineCheckTest { @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void test() throws UnsupportedEncodingException, IOException { check.maximumLineLength = 20; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/LineLength.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/LineLength.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(5).withMessage("Split this 28 characters long line (which is greater than 20 authorized).") diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFileCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFileCheckTest.java index 62fcc9c157..8a8bcba062 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFileCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFileCheckTest.java @@ -25,8 +25,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class TooManyLinesOfCodeInFileCheckTest { @@ -36,8 +36,8 @@ public class TooManyLinesOfCodeInFileCheckTest { @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void test() throws UnsupportedEncodingException, IOException { check.setMax(1); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/complexity.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/complexity.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().withMessage( @@ -48,8 +48,8 @@ public void test() throws UnsupportedEncodingException, IOException { @Test @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void test2() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/complexity.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/complexity.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .noMore(); diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFunctionCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFunctionCheckTest.java index 28d227ee65..24d0488a97 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFunctionCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyLinesOfCodeInFunctionCheckTest.java @@ -26,8 +26,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class TooManyLinesOfCodeInFunctionCheckTest { @@ -38,8 +38,8 @@ public class TooManyLinesOfCodeInFunctionCheckTest { @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void test() throws UnsupportedEncodingException, IOException { check.setMax(6); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FunctionLength.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/FunctionLength.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(21) .noMore(); diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyParametersCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyParametersCheckTest.java index 85c18875a7..eeeb7e336a 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyParametersCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyParametersCheckTest.java @@ -23,10 +23,9 @@ import java.io.UnsupportedEncodingException; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; -import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class TooManyParametersCheckTest { @@ -36,9 +35,8 @@ public void test() throws UnsupportedEncodingException, IOException { var check = new TooManyParametersCheck(); check.setMax(3); - CxxFileTester tester = CxxFileTesterHelper - .CreateCxxFileTester("src/test/resources/checks/TooManyParameters.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/TooManyParameters.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(11) .next().atLine(16) diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyStatementsPerLineCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyStatementsPerLineCheckTest.java index 27bb847d2a..3fbf339af6 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyStatementsPerLineCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/metrics/TooManyStatementsPerLineCheckTest.java @@ -24,10 +24,9 @@ import static org.assertj.core.api.Assertions.assertThat; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; -import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class TooManyStatementsPerLineCheckTest { @@ -37,9 +36,8 @@ public void test() throws UnsupportedEncodingException, IOException { var check = new TooManyStatementsPerLineCheck(); check.excludeCaseBreak = false; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester( - "src/test/resources/checks/TooManyStatementsPerLine.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/TooManyStatementsPerLine.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(17).withMessage( @@ -64,9 +62,8 @@ public void testExcludeCaseBreak() throws UnsupportedEncodingException, IOExcept var check = new TooManyStatementsPerLineCheck(); check.excludeCaseBreak = true; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester( - "src/test/resources/checks/TooManyStatementsPerLine.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/TooManyStatementsPerLine.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(17).withMessage( "At most one statement is allowed per line, but 2 statements were found on this line.") diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/ClassNameCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/ClassNameCheckTest.java index 0af083d982..e91f2d2fae 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/ClassNameCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/ClassNameCheckTest.java @@ -23,8 +23,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class ClassNameCheckTest { @@ -33,8 +33,8 @@ public class ClassNameCheckTest { public void test() throws Exception { var check = new ClassNameCheck(); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/ClassName.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/ClassName.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(3).withMessage( "Rename class \"MyClass_WithNotCompliantName1\" to match the regular expression ^[A-Z_][a-zA-Z0-9]+$.") diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/FileNameCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/FileNameCheckTest.java index 13ec650b60..4ef7d4aeaf 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/FileNameCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/FileNameCheckTest.java @@ -26,8 +26,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifierRule; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifierRule; public class FileNameCheckTest { @@ -38,8 +38,8 @@ public class FileNameCheckTest { @Test @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void bad_name() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/badFile_name.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/badFile_name.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); String format = "(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$"; String message = "Rename this file to match this regular expression: \"%s\"."; @@ -50,8 +50,8 @@ public void bad_name() throws UnsupportedEncodingException, IOException { @Test @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void good_name_camel_case() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileName.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/FileName.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); checkMessagesVerifier.verify(file.getCheckMessages()); } @@ -59,8 +59,8 @@ public void good_name_camel_case() throws UnsupportedEncodingException, IOExcept @Test @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void good_name_snake_case() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/file_name.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/file_name.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); checkMessagesVerifier.verify(file.getCheckMessages()); } diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/FunctionNameCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/FunctionNameCheckTest.java index 39162f26cc..87ee7c748f 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/FunctionNameCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/FunctionNameCheckTest.java @@ -23,8 +23,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class FunctionNameCheckTest { @@ -33,8 +33,8 @@ public class FunctionNameCheckTest { public void test() throws Exception { var check = new FunctionNameCheck(); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FunctionName.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/FunctionName.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(8).withMessage( "Rename function \"Badly_Named_Function\" to match the regular expression ^[a-z_][a-z0-9_]{2,30}$.") diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/MethodNameCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/MethodNameCheckTest.java index 834ac7281b..65f83223a6 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/MethodNameCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/naming/MethodNameCheckTest.java @@ -23,8 +23,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class MethodNameCheckTest { @@ -32,8 +32,8 @@ public class MethodNameCheckTest { @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void test() throws Exception { var check = new MethodNameCheck(); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/MethodName.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/MethodName.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(12).withMessage( "Rename method \"Badly_Named_Method2\" to match the regular expression ^[A-Z][A-Za-z0-9]{2,30}$.") diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/CommentRegularExpressionCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/CommentRegularExpressionCheckTest.java index 20656cd0c1..e2ef69e16e 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/CommentRegularExpressionCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/CommentRegularExpressionCheckTest.java @@ -23,10 +23,9 @@ import java.io.UnsupportedEncodingException; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; -import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class CommentRegularExpressionCheckTest { @@ -37,10 +36,9 @@ public void test() throws UnsupportedEncodingException, IOException { check.regularExpression = "(?i).*TODO.*"; check.message = "Avoid TODO"; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester( - "src/test/resources/checks/commentRegularExpression.cc", "."); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/commentRegularExpression.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(3).withMessage("Avoid TODO") .next().atLine(5) diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FileHeaderCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FileHeaderCheckTest.java index 67cc0301a1..10853b29be 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FileHeaderCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FileHeaderCheckTest.java @@ -27,8 +27,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class FileHeaderCheckTest { @@ -38,68 +38,68 @@ public void test() throws UnsupportedEncodingException, IOException { var check = new FileHeaderCheck(); check.headerFormat = "// copyright 2005"; - CxxFileTester tester = CxxFileTesterHelper - .CreateCxxFileTester("src/test/resources/checks/FileHeaderCheck/Class1.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper + .create("src/test/resources/checks/FileHeaderCheck/Class1.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); assertThat(file.getCheckMessages()).isNullOrEmpty(); check = new FileHeaderCheck(); check.headerFormat = "// copyright 20\\d\\d"; - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(null); check = new FileHeaderCheck(); check.headerFormat = "// copyright 2005"; - tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileHeaderCheck/Class2.cc", "."); - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + tester = CxxFileTesterHelper.create("src/test/resources/checks/FileHeaderCheck/Class2.cc", "."); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(null).withMessage("Add or update the header of this file."); check = new FileHeaderCheck(); check.headerFormat = "// copyright 2012"; - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); assertThat(file.getCheckMessages()).isNullOrEmpty(); check = new FileHeaderCheck(); check.headerFormat = "// copyright 2012\n// foo"; - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); assertThat(file.getCheckMessages()).isNullOrEmpty(); check = new FileHeaderCheck(); check.headerFormat = "// copyright 2012\r\n// foo"; - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); assertThat(file.getCheckMessages()).isNullOrEmpty(); check = new FileHeaderCheck(); check.headerFormat = "// copyright 2012\r// foo"; - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); assertThat(file.getCheckMessages()).isNullOrEmpty(); check = new FileHeaderCheck(); check.headerFormat = "// copyright 2012\r\r// foo"; - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(null); check = new FileHeaderCheck(); check.headerFormat = "// copyright 2012\n// foo\n\n\n\n\n\n\n\n\n\ngfoo"; - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(null); check = new FileHeaderCheck(); check.headerFormat = "/*foo http://www.example.org*/"; - tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileHeaderCheck/Class3.cc", "."); - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + tester = CxxFileTesterHelper.create("src/test/resources/checks/FileHeaderCheck/Class3.cc", "."); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); assertThat(file.getCheckMessages()).isNullOrEmpty(); } @@ -110,15 +110,15 @@ public void regex() throws UnsupportedEncodingException, IOException { check.headerFormat = "// copyright \\d\\d\\d"; check.isRegularExpression = true; - CxxFileTester tester = CxxFileTesterHelper - .CreateCxxFileTester("src/test/resources/checks/FileHeaderCheck/Regex1.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper + .create("src/test/resources/checks/FileHeaderCheck/Regex1.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()).next().atLine(null).withMessage( "Add or update the header of this file."); // Check that the regular expression is compiled once check = new FileHeaderCheck(); - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()).next().atLine(null).withMessage( "Add or update the header of this file."); @@ -126,8 +126,8 @@ public void regex() throws UnsupportedEncodingException, IOException { check.headerFormat = "// copyright \\d{4}\\n// mycompany"; check.isRegularExpression = true; - tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileHeaderCheck/Regex2.cc", "."); - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + tester = CxxFileTesterHelper.create("src/test/resources/checks/FileHeaderCheck/Regex2.cc", "."); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()).next().atLine(null).withMessage( "Add or update the header of this file."); @@ -135,16 +135,16 @@ public void regex() throws UnsupportedEncodingException, IOException { check.headerFormat = "// copyright \\d{4}\\r?\\n// mycompany"; check.isRegularExpression = true; - tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileHeaderCheck/Regex3.cc", "."); - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + tester = CxxFileTesterHelper.create("src/test/resources/checks/FileHeaderCheck/Regex3.cc", "."); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); assertThat(file.getCheckMessages()).isNullOrEmpty(); check = new FileHeaderCheck(); check.headerFormat = "// copyright \\d{4}\\n// mycompany"; check.isRegularExpression = true; - tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileHeaderCheck/Regex4.cc", "."); - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + tester = CxxFileTesterHelper.create("src/test/resources/checks/FileHeaderCheck/Regex4.cc", "."); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()).next().atLine(null).withMessage( "Add or update the header of this file."); @@ -152,14 +152,14 @@ public void regex() throws UnsupportedEncodingException, IOException { check.headerFormat = "^(?=.*?\\bCopyright\\b)(?=.*?\\bVendor\\b)(?=.*?\\d{4}(-\\d{4})?).*$"; check.isRegularExpression = true; - tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileHeaderCheck/Regex5.cc", "."); - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + tester = CxxFileTesterHelper.create("src/test/resources/checks/FileHeaderCheck/Regex5.cc", "."); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); assertThat(file.getCheckMessages()).isNullOrEmpty(); check = new FileHeaderCheck(); - tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileHeaderCheck/Regex6.cc", "."); - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + tester = CxxFileTesterHelper.create("src/test/resources/checks/FileHeaderCheck/Regex6.cc", "."); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()).next().atLine(null).withMessage( "Add or update the header of this file."); @@ -169,8 +169,8 @@ public void regex() throws UnsupportedEncodingException, IOException { + "//\\s*\\s*"; check.isRegularExpression = true; - tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileHeaderCheck/Regex7.cc", "."); - file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + tester = CxxFileTesterHelper.create("src/test/resources/checks/FileHeaderCheck/Regex7.cc", "."); + file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); assertThat(file.getCheckMessages()).isNullOrEmpty(); } diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FileRegularExpressionCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FileRegularExpressionCheckTest.java index c3df0742c5..78ab26794e 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FileRegularExpressionCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FileRegularExpressionCheckTest.java @@ -27,8 +27,8 @@ import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; import org.sonar.cxx.config.CxxSquidConfiguration; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class FileRegularExpressionCheckTest { @@ -38,8 +38,8 @@ public void fileRegExWithoutFilePattern() throws UnsupportedEncodingException, I var check = new FileRegularExpressionCheck(); check.regularExpression = "stdafx\\.h"; check.message = "Found 'stdafx.h' in file!"; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileRegEx.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/FileRegEx.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().withMessage(check.message) @@ -55,9 +55,9 @@ public void fileRegExInvertWithoutFilePattern() throws UnsupportedEncodingExcept check.invertRegularExpression = true; check.message = "Found no 'stdafx.h' in file!"; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileRegExInvert.cc", "."); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/FileRegExInvert.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig, check); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig, check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().withMessage(check.message) .noMore(); @@ -71,10 +71,10 @@ public void fileRegExCodingErrorActionReplace() throws UnsupportedEncodingExcept check.regularExpression = "stdafx\\.h"; check.message = "Found 'stdafx.h' in file!"; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileRegEx.cc", ".", - StandardCharsets.US_ASCII); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/FileRegEx.cc", ".", + StandardCharsets.US_ASCII); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig, check); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig, check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().withMessage(check.message) .noMore(); @@ -89,8 +89,8 @@ public void fileRegExWithFilePattern() throws UnsupportedEncodingException, IOEx check.regularExpression = "#include\\s+\"stdafx\\.h\""; check.message = "Found '#include \"stdafx.h\"' in a .cc file!"; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileRegEx.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig, check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/FileRegEx.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig, check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().withMessage(check.message) @@ -108,8 +108,8 @@ public void fileRegExInvertWithFilePatternInvert() throws UnsupportedEncodingExc check.invertRegularExpression = true; check.message = "Found no '#include \"stdafx.h\"' in a file with not '.h' file extension!"; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FileRegExInvert.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig, check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/FileRegExInvert.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig, check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().withMessage(check.message) diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FixmeTagPresenceCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FixmeTagPresenceCheckTest.java index 4bb3792a2b..43155b8734 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FixmeTagPresenceCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/FixmeTagPresenceCheckTest.java @@ -26,8 +26,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifierRule; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifierRule; public class FixmeTagPresenceCheckTest { @@ -37,9 +37,9 @@ public class FixmeTagPresenceCheckTest { @Test @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void detected() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/FixmeTagPresenceCheck.cc", - "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), new FixmeTagPresenceCheck()); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/FixmeTagPresenceCheck.cc", + "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), new FixmeTagPresenceCheck()); checkMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(3).withMessage("Take the required action to fix the issue indicated by this comment.") diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/LineRegularExpressionCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/LineRegularExpressionCheckTest.java index 3aaf1c0b04..6e5347414a 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/LineRegularExpressionCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/LineRegularExpressionCheckTest.java @@ -25,8 +25,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class LineRegularExpressionCheckTest { @@ -36,8 +36,8 @@ public void lineRegExWithoutFilePattern() throws UnsupportedEncodingException, I var check = new LineRegularExpressionCheck(); check.regularExpression = "stdafx\\.h"; check.message = "Found 'stdafx.h' in line!"; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/LineRegEx.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/LineRegEx.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(2).withMessage(check.message) @@ -52,8 +52,8 @@ public void lineRegExInvertWithoutFilePattern() throws UnsupportedEncodingExcept check.regularExpression = "//.*"; check.invertRegularExpression = true; check.message = "Found no comment in the line!"; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/LineRegExInvert.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/LineRegExInvert.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(3).withMessage(check.message) @@ -68,8 +68,8 @@ public void lineRegExWithFilePattern1() throws UnsupportedEncodingException, IOE check.regularExpression = "#include\\s+\"stdafx\\.h\""; check.message = "Found '#include \"stdafx.h\"' in line in a .cc file!"; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/LineRegEx.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/LineRegEx.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(2).withMessage(check.message) @@ -86,8 +86,8 @@ public void lineRegExWithFilePatternInvert() throws UnsupportedEncodingException check.regularExpression = "#include\\s+\"stdafx\\.h\""; check.message = "Found '#include \"stdafx.h\"' in line in a not .xx file!"; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/LineRegEx.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/LineRegEx.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(2).withMessage(check.message) @@ -103,8 +103,8 @@ public void lineRegExWithFilePattern2() throws UnsupportedEncodingException, IOE check.regularExpression = "#include\\s+\"stdafx\\.h\""; check.message = "Found '#include \"stdafx.h\"' in line in a .xx file!"; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/LineRegEx.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/LineRegEx.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .noMore(); diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/NoSonarCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/NoSonarCheckTest.java index f97009bda6..aaa67dcb9b 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/NoSonarCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/NoSonarCheckTest.java @@ -23,10 +23,9 @@ import java.io.UnsupportedEncodingException; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; -import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class NoSonarCheckTest { @@ -35,9 +34,8 @@ public class NoSonarCheckTest { @Test @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void test() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester( - "src/test/resources/checks/NoSonarTagPresenceCheck.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/NoSonarTagPresenceCheck.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(2).withMessage("Is //NOSONAR used to exclude false-positive or to hide real quality flaw ?") diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/TodoTagPresenceCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/TodoTagPresenceCheckTest.java index 9ee69061d7..4bc3df7ffc 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/TodoTagPresenceCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/regex/TodoTagPresenceCheckTest.java @@ -26,8 +26,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifierRule; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifierRule; public class TodoTagPresenceCheckTest { @@ -37,9 +37,9 @@ public class TodoTagPresenceCheckTest { @Test @SuppressWarnings("squid:S2699") // ... verify contains the assertion public void detected() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/TodoTagPresenceCheck.cc", - "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), new TodoTagPresenceCheck()); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/TodoTagPresenceCheck.cc", + "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), new TodoTagPresenceCheck()); checkMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(3).withMessage("Complete the task associated to this TODO comment.") diff --git a/cxx-checks/src/test/java/org/sonar/cxx/checks/xpath/XPathCheckTest.java b/cxx-checks/src/test/java/org/sonar/cxx/checks/xpath/XPathCheckTest.java index f85ca51209..fe4387e198 100644 --- a/cxx-checks/src/test/java/org/sonar/cxx/checks/xpath/XPathCheckTest.java +++ b/cxx-checks/src/test/java/org/sonar/cxx/checks/xpath/XPathCheckTest.java @@ -25,8 +25,8 @@ import org.sonar.cxx.CxxAstScanner; import org.sonar.cxx.checks.CxxFileTester; import org.sonar.cxx.checks.CxxFileTesterHelper; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.CheckMessagesVerifier; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifier; public class XPathCheckTest { @@ -37,8 +37,8 @@ public void xpathWithoutFilePattern() throws UnsupportedEncodingException, IOExc check.xpathQuery = "//declaration"; check.message = "Avoid declarations!! "; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/xpath.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/xpath.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(1).withMessage(check.message) .noMore(); @@ -52,8 +52,8 @@ public void xpathWithFilePattern1() throws UnsupportedEncodingException, IOExcep check.xpathQuery = "//declaration"; check.message = "Avoid declarations!! "; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/xpath.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/xpath.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(1).withMessage(check.message) .noMore(); @@ -67,8 +67,8 @@ public void xpathWithFilePattern2() throws UnsupportedEncodingException, IOExcep check.xpathQuery = "//declaration"; check.message = "Avoid declarations!! "; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/xpath.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/xpath.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(1).withMessage(check.message) .noMore(); @@ -82,8 +82,8 @@ public void xpathWithFilePattern3() throws UnsupportedEncodingException, IOExcep check.xpathQuery = "//declaration"; check.message = "Avoid declarations!! "; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/xpath.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/xpath.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .noMore(); } @@ -97,8 +97,8 @@ public void xpathWithFilePatternInvert() throws UnsupportedEncodingException, IO check.xpathQuery = "//declaration"; check.message = "Avoid declarations!! "; - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/checks/xpath.cc", "."); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), check); + var tester = CxxFileTesterHelper.create("src/test/resources/checks/xpath.cc", "."); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), check); CheckMessagesVerifier.verify(file.getCheckMessages()) .next().atLine(1).withMessage(check.message) .noMore(); diff --git a/cxx-sensors/src/main/java/org/sonar/cxx/sensors/clangtidy/CxxClangTidySensor.java b/cxx-sensors/src/main/java/org/sonar/cxx/sensors/clangtidy/CxxClangTidySensor.java index 19c1ba2620..66d9eefb1a 100644 --- a/cxx-sensors/src/main/java/org/sonar/cxx/sensors/clangtidy/CxxClangTidySensor.java +++ b/cxx-sensors/src/main/java/org/sonar/cxx/sensors/clangtidy/CxxClangTidySensor.java @@ -113,9 +113,10 @@ public void describe(SensorDescriptor descriptor) { @Override protected void processReport(File report) { String reportEncoding = context.config().get(REPORT_ENCODING_DEF).orElse(DEFAULT_ENCODING_DEF); - LOG.debug("Encoding='{}'", reportEncoding); try ( var scanner = new TextScanner(report, reportEncoding)) { + LOG.debug("Encoding='{}'", scanner.encoding()); + // sample: // c:\a\file.cc:5:20: warning: ... conversion from string literal to 'char *' [clang-diagnostic-writable-strings] CxxReportIssue currentIssue = null; diff --git a/cxx-sensors/src/main/java/org/sonar/cxx/sensors/compiler/CxxCompilerSensor.java b/cxx-sensors/src/main/java/org/sonar/cxx/sensors/compiler/CxxCompilerSensor.java index 4afde7a54f..5515576347 100644 --- a/cxx-sensors/src/main/java/org/sonar/cxx/sensors/compiler/CxxCompilerSensor.java +++ b/cxx-sensors/src/main/java/org/sonar/cxx/sensors/compiler/CxxCompilerSensor.java @@ -60,7 +60,7 @@ protected void processReport(File report) { try ( var scanner = new TextScanner(report, reportEncoding)) { Pattern pattern = Pattern.compile(reportRegEx); LOG.debug("Processing '{}' report '{}', Encoding='{}', Pattern='{}'", - getCompilerKey(), report, reportEncoding, pattern); + getCompilerKey(), report, scanner.encoding(), pattern); while (scanner.hasNextLine()) { Matcher matcher = pattern.matcher(scanner.nextLine()); diff --git a/cxx-sensors/src/main/java/org/sonar/cxx/sensors/utils/TextScanner.java b/cxx-sensors/src/main/java/org/sonar/cxx/sensors/utils/TextScanner.java index 259eaf208d..c616e93eb6 100644 --- a/cxx-sensors/src/main/java/org/sonar/cxx/sensors/utils/TextScanner.java +++ b/cxx-sensors/src/main/java/org/sonar/cxx/sensors/utils/TextScanner.java @@ -32,7 +32,8 @@ public class TextScanner implements Closeable { - private Scanner scanner; + private final Scanner scanner; + private final String encoding; /** * Constructs a new {@code Scanner} that produces values scanned from the specified file. @@ -47,19 +48,23 @@ public class TextScanner implements Closeable { * @throws IllegalArgumentException if the specified encoding is not found */ public TextScanner(File source, String defaultEncoding) throws IOException { - String encodingName; - - try ( BOMInputStream bomInputStream = new BOMInputStream(new FileInputStream(source), - ByteOrderMark.UTF_8, - ByteOrderMark.UTF_16LE, - ByteOrderMark.UTF_16BE, - ByteOrderMark.UTF_32LE, - ByteOrderMark.UTF_32BE)) { + BOMInputStream bomInputStream = null; + try { + bomInputStream = new BOMInputStream(new FileInputStream(source), + ByteOrderMark.UTF_8, + ByteOrderMark.UTF_16LE, + ByteOrderMark.UTF_16BE, + ByteOrderMark.UTF_32LE, + ByteOrderMark.UTF_32BE); ByteOrderMark bom = bomInputStream.getBOM(); - encodingName = bom == null ? defaultEncoding : bom.getCharsetName(); + encoding = (bom != null) ? bom.getCharsetName() : defaultEncoding; + scanner = new Scanner(bomInputStream, encoding); + } catch (IOException e) { + if (bomInputStream != null) { + bomInputStream.close(); + } + throw e; } - - scanner = new Scanner(source, encodingName); } /** @@ -75,6 +80,7 @@ public TextScanner(File source, String defaultEncoding) throws IOException { * in an {@link IllegalStateException}. * */ + @Override public void close() { scanner.close(); } @@ -135,4 +141,11 @@ public String nextLine() { return scanner.nextLine(); } + /** + * @return encoding used by the scanner + */ + public String encoding() { + return encoding; + } + } diff --git a/cxx-sensors/src/test/java/org/sonar/cxx/postjobs/FinalReportTest.java b/cxx-sensors/src/test/java/org/sonar/cxx/postjobs/FinalReportTest.java index f1bffdcf97..d517953b6a 100644 --- a/cxx-sensors/src/test/java/org/sonar/cxx/postjobs/FinalReportTest.java +++ b/cxx-sensors/src/test/java/org/sonar/cxx/postjobs/FinalReportTest.java @@ -20,11 +20,18 @@ package org.sonar.cxx.postjobs; import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.file.Paths; +import org.apache.commons.io.ByteOrderMark; +import org.apache.commons.io.input.BOMInputStream; import static org.assertj.core.api.Assertions.assertThat; import org.junit.Before; import org.junit.Test; import org.mockito.Mockito; import org.sonar.api.batch.fs.InputFile; +import org.sonar.api.batch.fs.internal.DefaultInputFile; import org.sonar.api.batch.fs.internal.TestInputFileBuilder; import org.sonar.api.batch.postjob.PostJobContext; import org.sonar.api.batch.sensor.internal.SensorContextTester; @@ -46,15 +53,15 @@ public void scanFile() { } @Test - public void finalReportTest() { + public void finalReportTest() throws IOException { var dir = "src/test/resources/org/sonar/cxx/postjobs"; var context = SensorContextTester.create(new File(dir)); - InputFile inputFile = TestInputFileBuilder.create("", dir + "/syntaxerror.cc").build(); + InputFile inputFile = createInputFile(dir + "/syntaxerror.cc", ".", Charset.defaultCharset()); context.fileSystem().add(inputFile); CxxParseErrorLoggerVisitor.resetReport(); CxxPreprocessor.resetReport(); - CxxAstScanner.scanSingleFile(new File(inputFile.uri().getPath())); + CxxAstScanner.scanSingleInputFile(inputFile); var postjob = new FinalReport(); postjob.execute(postJobContext); @@ -65,4 +72,29 @@ public void finalReportTest() { assertThat(log.get(1)).contains("syntax error(s) detected"); } + private static DefaultInputFile createInputFile(String fileName, String basePath, Charset charset) + throws IOException { + TestInputFileBuilder fb = TestInputFileBuilder.create("", fileName); + + fb.setCharset(charset); + fb.setProjectBaseDir(Paths.get(basePath)); + fb.setContents(getSourceCode(Paths.get(basePath, fileName).toFile(), charset)); + + return fb.build(); + } + + private static String getSourceCode(File filename, Charset defaultCharset) throws IOException { + try ( BOMInputStream bomInputStream = new BOMInputStream(new FileInputStream(filename), + ByteOrderMark.UTF_8, + ByteOrderMark.UTF_16LE, + ByteOrderMark.UTF_16BE, + ByteOrderMark.UTF_32LE, + ByteOrderMark.UTF_32BE)) { + ByteOrderMark bom = bomInputStream.getBOM(); + Charset charset = bom != null ? Charset.forName(bom.getCharsetName()) : defaultCharset; + byte[] bytes = bomInputStream.readAllBytes(); + return new String(bytes, charset); + } + } + } diff --git a/cxx-squid-bridge/LICENSE b/cxx-squid-bridge/LICENSE new file mode 100644 index 0000000000..65c5ca88a6 --- /dev/null +++ b/cxx-squid-bridge/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. diff --git a/cxx-squid-bridge/README.md b/cxx-squid-bridge/README.md new file mode 100644 index 0000000000..312029da11 --- /dev/null +++ b/cxx-squid-bridge/README.md @@ -0,0 +1,55 @@ +This is a fork of: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + +In the original version, some features were discontinued in subsequent versions, which will be further developed within the scope of this fork. + +# Original copyright text: + +```Java +/* + * SSLR Squid Bridge + * Copyright (C) 2010 SonarSource + * sonarqube@googlegroups.com + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 + */ +``` + +# Copyright of the fork: + +```Java +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +``` diff --git a/cxx-squid-bridge/pom.xml b/cxx-squid-bridge/pom.xml new file mode 100644 index 0000000000..463cc13166 --- /dev/null +++ b/cxx-squid-bridge/pom.xml @@ -0,0 +1,103 @@ + + + 4.0.0 + + + org.sonarsource.sonarqube-plugins.cxx + cxx + 2.0.2-SNAPSHOT + + + cxx-squid-bridge + + Cxx :: Language Recognizer :: Squid Bridge + + + 2021 + ${basedir}/../${aggregate.report.dir} + + + + + org.sonarsource.sslr + sslr-core + + + org.sonarsource.sslr + sslr-xpath + + + org.sonarsource.sslr + sslr-testing-harness + test + + + org.sonarsource.sonarqube + sonar-plugin-api + provided + + + org.picocontainer + picocontainer + 2.14.1 + + + org.slf4j + slf4j-api + 1.5.6 + + + org.slf4j + jcl-over-slf4j + 1.5.6 + + + com.fasterxml.staxmate + staxmate + 2.4.0 + + + junit + junit + + true + + + com.google.guava + guava + + + commons-io + commons-io + + + commons-lang + commons-lang + + + ch.qos.logback + logback-classic + 0.9.15 + test + + + org.mockito + mockito-all + 1.8.5 + test + + + org.easytesting + fest-assert + 1.4 + test + + + com.jayway.awaitility + awaitility + 1.6.5 + test + + + + diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/AstScanner.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/AstScanner.java new file mode 100644 index 0000000000..4afa0a7022 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/AstScanner.java @@ -0,0 +1,274 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import static com.google.common.base.Preconditions.checkNotNull; +import static com.google.common.base.Preconditions.checkState; +import com.google.common.base.Throwables; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.Lists; +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.RecognitionException; +import com.sonar.sslr.impl.Parser; +import com.sonar.sslr.impl.ast.AstWalker; +import java.io.File; +import java.io.InterruptedIOException; +import java.util.Collection; +import java.util.List; +import org.sonar.api.batch.fs.InputFile; +import org.sonar.api.utils.log.Logger; +import org.sonar.api.utils.log.Loggers; +import org.sonar.cxx.squidbridge.api.AnalysisException; +import org.sonar.cxx.squidbridge.api.SourceCodeSearchEngine; +import org.sonar.cxx.squidbridge.api.SourceCodeTreeDecorator; +import org.sonar.cxx.squidbridge.api.SourceProject; +import org.sonar.cxx.squidbridge.indexer.SquidIndex; +import org.sonar.cxx.squidbridge.measures.MetricDef; + +public class AstScanner { + + private static final Logger LOG = Loggers.get(AstScanner.class); + + private final List> visitors; + private final Parser parser; + private final SquidAstVisitorContextImpl context; + + private final SquidIndex indexer = new SquidIndex(); + private final MetricDef[] metrics; + private final MetricDef filesMetric; + + protected AstScanner(Builder builder) { + this.visitors = Lists.newArrayList(builder.visitors); + this.parser = builder.baseParser; + this.context = builder.context; + + this.context.setGrammar(parser.getGrammar()); + this.context.getProject().setSourceCodeIndexer(indexer); + this.context.setCommentAnalyser(builder.commentAnalyser); + this.metrics = builder.metrics; + this.filesMetric = builder.filesMetric; + indexer.index(context.getProject()); + } + + public SourceCodeSearchEngine getIndex() { + return indexer; + } + + public void scanFile(File file) { + scanFiles(ImmutableList.of(file)); + } + + public void scanInputFile(InputFile inputFile) { + scanInputFiles(ImmutableList.of(inputFile)); + } + + public void scanFiles(Collection files) { + initVisitors(); + + AstWalker astWalker = new AstWalker(visitors); + + for (File file : files) { + checkCancel(); + context.setFile(file, filesMetric); + + Exception parseException = null; + AstNode ast = null; + try { + try { + ast = parser.parse(file); + } catch (Exception e) { + parseException = handleParseException(file, e); + } + walkAndVisit(astWalker, ast, parseException); + } catch (Throwable e) { + throw new AnalysisException("Unable to parse file: " + file.getAbsolutePath(), e); + } + } + + destroyVisitors(); + decorateSquidTree(); + } + + public void scanInputFiles(Iterable inputFiles) { + initVisitors(); + + AstWalker astWalker = new AstWalker(visitors); + + for (InputFile inputFile : inputFiles) { + File file = new File(inputFile.uri().getPath()); + checkCancel(); + context.setInputFile(inputFile, filesMetric); + + Exception parseException = null; + AstNode ast = null; + try { + try { + ast = parser.parse(inputFile.contents()); + } catch (Exception e) { + parseException = handleParseException(file, e); + } + walkAndVisit(astWalker, ast, parseException); + } catch (Throwable e) { + throw new AnalysisException("Unable to parse file: " + file.getAbsolutePath(), e); + } + } + + destroyVisitors(); + decorateSquidTree(); + } + + private Exception handleParseException(File file, Exception e) { + checkInterrupted(e); + if (e instanceof RecognitionException) { + LOG.error("Unable to parse file: " + file.getAbsolutePath()); + LOG.error(e.getMessage()); + } else { + LOG.error("Unable to parse file: " + file.getAbsolutePath(), e); + } + return e; + } + + private void walkAndVisit(AstWalker astWalker, AstNode ast, Exception parseException) throws Throwable { + if (parseException == null) { + astWalker.walkAndVisit(ast); + } else { + // process parse error + for (SquidAstVisitor visitor : visitors) { + visitor.visitFile(ast); + } + for (SquidAstVisitor visitor : visitors) { + if (visitor instanceof AstScannerExceptionHandler) { + if (parseException instanceof RecognitionException) { + ((AstScannerExceptionHandler) visitor) + .processRecognitionException((RecognitionException) parseException); + } else { + ((AstScannerExceptionHandler) visitor).processException(parseException); + } + } + } + for (SquidAstVisitor visitor : visitors) { + visitor.leaveFile(ast); + } + } + context.popTillSourceProject(); + } + + private void initVisitors() { + for (SquidAstVisitor visitor : visitors) { + visitor.init(); + } + } + + private void destroyVisitors() { + for (SquidAstVisitor visitor : visitors) { + visitor.destroy(); + } + } + + /** + * Checks if the root cause of the thread is related to an interrupt. + * Note that when such an exception is thrown, the interrupt flag is reset. + */ + private static void checkInterrupted(Exception e) { + Throwable cause = Throwables.getRootCause(e); + if (cause instanceof InterruptedException || cause instanceof InterruptedIOException) { + throw new AnalysisException("Analysis cancelled", e); + } + } + + private static void checkCancel() { + if (Thread.interrupted()) { + throw new AnalysisException("Analysis cancelled"); + } + } + + protected void decorateSquidTree() { + if (metrics != null && metrics.length > 0) { + SourceProject project = context.getProject(); + SourceCodeTreeDecorator decorator = new SourceCodeTreeDecorator(project); + decorator.decorateWith(metrics); + } + } + + public static Builder builder(SquidAstVisitorContextImpl context) { + return new Builder(context); + } + + public static class Builder { + + private Parser baseParser; + private final List> visitors = Lists.newArrayList(); + private final SquidAstVisitorContextImpl context; + private CommentAnalyser commentAnalyser; + private MetricDef[] metrics; + private MetricDef filesMetric; + + public Builder(SquidAstVisitorContextImpl context) { + checkNotNull(context, "context cannot be null"); + this.context = context; + } + + public Builder setBaseParser(Parser baseParser) { + checkNotNull(baseParser, "baseParser cannot be null"); + this.baseParser = baseParser; + return this; + } + + public Builder setCommentAnalyser(CommentAnalyser commentAnalyser) { + checkNotNull(commentAnalyser, "commentAnalyser cannot be null"); + this.commentAnalyser = commentAnalyser; + return this; + } + + public Builder withSquidAstVisitor(SquidAstVisitor visitor) { + checkNotNull(visitor, "visitor cannot be null"); + visitor.setContext(context); + visitors.add(visitor); + return this; + } + + public Builder withMetrics(MetricDef... metrics) { + for (MetricDef metric : metrics) { + checkNotNull(metric, "metrics cannot be null"); + } + this.metrics = metrics; + return this; + } + + public Builder setFilesMetric(MetricDef filesMetric) { + checkNotNull(filesMetric, "filesMetric cannot be null"); + this.filesMetric = filesMetric; + return this; + } + + public AstScanner build() { + checkState(baseParser != null, "baseParser must be set"); + checkState(commentAnalyser != null, "commentAnalyser must be set"); + checkState(filesMetric != null, "filesMetric must be set"); + return new AstScanner(this); + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/AstScannerExceptionHandler.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/AstScannerExceptionHandler.java new file mode 100644 index 0000000000..e93293a7f5 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/AstScannerExceptionHandler.java @@ -0,0 +1,37 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import com.sonar.sslr.api.RecognitionException; + +/** + * @since 2.3 + */ +public interface AstScannerExceptionHandler { + + void processRecognitionException(RecognitionException e); + + void processException(Exception e); + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/CommentAnalyser.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/CommentAnalyser.java new file mode 100644 index 0000000000..e915caa33a --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/CommentAnalyser.java @@ -0,0 +1,46 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +public abstract class CommentAnalyser { + + /** + * Check whether or not a comment line is blank + * + * @param line + * A line of the comment, excluding the comment tags + * @return true if the line is considered blank and false otherwise + */ + public abstract boolean isBlank(String line); + + /** + * Extract the content of a comment, i.e. remove the comment tags + * + * @param comment + * Raw comment value + * @return The content of the comment, without the tags + */ + public abstract String getContents(String comment); + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/ProgressAstScanner.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/ProgressAstScanner.java new file mode 100644 index 0000000000..ab87f31d26 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/ProgressAstScanner.java @@ -0,0 +1,88 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.Grammar; +import java.io.File; +import java.util.Collection; +import java.util.concurrent.TimeUnit; +import javax.annotation.Nullable; + +public class ProgressAstScanner extends AstScanner { + + private final ProgressReport progressReport; + + protected ProgressAstScanner(Builder builder) { + super(builder); + this.progressReport = builder.progressReport; + } + + @Override + public void scanFiles(Collection files) { + progressReport.start(files); + boolean success = false; + try { + super.scanFiles(files); + success = true; + } finally { + if (success) { + progressReport.stop(); + } else { + progressReport.cancel(); + } + } + } + + public static class Builder extends AstScanner.Builder { + + private ProgressReport progressReport = new ProgressReport("Report about progress of code analyzer", + TimeUnit.SECONDS.toMillis(10)); + + public Builder(SquidAstVisitorContextImpl context) { + super(context); + } + + public Builder setProgressReport(ProgressReport progressReport) { + this.progressReport = progressReport; + return this; + } + + @Override + public AstScanner build() { + super.withSquidAstVisitor(new SquidAstVisitor() { + + @Override + public void leaveFile(@Nullable AstNode astNode) { + progressReport.nextFile(); + } + + }); + + return new ProgressAstScanner(this); + } + + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/ProgressReport.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/ProgressReport.java new file mode 100644 index 0000000000..148fefceb6 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/ProgressReport.java @@ -0,0 +1,118 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import java.io.File; +import java.util.Collection; +import java.util.Iterator; +import org.sonar.api.utils.log.Logger; +import org.sonar.api.utils.log.Loggers; + +public class ProgressReport implements Runnable { + + private final long period; + private final Logger logger; + private int count; + private int currentFileNumber = -1; + private File currentFile; + private Iterator it; + private final Thread thread; + private final String adjective; + private boolean success = false; + + public ProgressReport(String threadName, long period, Logger logger, String adjective) { + this.period = period; + this.logger = logger; + this.adjective = adjective; + thread = new Thread(this); + thread.setName(threadName); + thread.setDaemon(true); + } + + public ProgressReport(String threadName, long period, String adjective) { + this(threadName, period, Loggers.get(ProgressReport.class), adjective); + } + + public ProgressReport(String threadName, long period) { + this(threadName, period, "analyzed"); + } + + @Override + public void run() { + while (!Thread.interrupted()) { + try { + Thread.sleep(period); + synchronized (this) { + log(currentFileNumber + "/" + count + " files " + adjective + ", current file: " + currentFile + .getAbsolutePath()); + } + } catch (InterruptedException e) { + break; + } + } + synchronized (this) { + if (success) { + log(count + "/" + count + " source files have been " + adjective); + } + } + } + + public synchronized void start(Collection files) { + count = files.size(); + it = files.iterator(); + + nextFile(); + + log(count + " source files to be " + adjective); + thread.start(); + } + + public synchronized void nextFile() { + if (it.hasNext()) { + currentFileNumber++; + currentFile = it.next(); + } + } + + public synchronized void stop() { + success = true; + thread.interrupt(); + } + + public synchronized void cancel() { + thread.interrupt(); + } + + public void join() throws InterruptedException { + thread.join(); + } + + private void log(String message) { + synchronized (logger) { + logger.info(message); + logger.notifyAll(); + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SourceCodeBuilderCallback.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SourceCodeBuilderCallback.java new file mode 100644 index 0000000000..a9db992ddc --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SourceCodeBuilderCallback.java @@ -0,0 +1,32 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import com.sonar.sslr.api.AstNode; +import org.sonar.cxx.squidbridge.api.SourceCode; + +public interface SourceCodeBuilderCallback { + + SourceCode createSourceCode(SourceCode parentSourceCode, AstNode astNode); +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SourceCodeBuilderVisitor.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SourceCodeBuilderVisitor.java new file mode 100644 index 0000000000..60b86736b3 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SourceCodeBuilderVisitor.java @@ -0,0 +1,66 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; + +/** + * Visitor that create resources. + */ +public class SourceCodeBuilderVisitor extends SquidAstVisitor { + + private final SourceCodeBuilderCallback callback; + private final AstNodeType[] astNodeTypes; + + public SourceCodeBuilderVisitor(SourceCodeBuilderCallback callback, AstNodeType... astNodeTypes) { + this.callback = callback; + this.astNodeTypes = astNodeTypes; + } + + @Override + public void init() { + for (AstNodeType astNodeType : astNodeTypes) { + subscribeTo(astNodeType); + } + } + + /** + * {@inheritDoc} + */ + @Override + public void visitNode(AstNode astNode) { + getContext().addSourceCode(callback.createSourceCode(getContext().peekSourceCode(), astNode)); + } + + /** + * {@inheritDoc} + */ + @Override + public void leaveNode(AstNode astNode) { + getContext().popSourceCode(); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SquidAstVisitor.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SquidAstVisitor.java new file mode 100644 index 0000000000..dd45a3b96a --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SquidAstVisitor.java @@ -0,0 +1,124 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.AstVisitor; +import com.sonar.sslr.api.Grammar; +import java.util.ArrayList; +import java.util.List; +import javax.annotation.Nullable; +import org.sonar.cxx.squidbridge.api.CodeVisitor; + +/** + * Base class to visit an AST (Abstract Syntactic Tree) generated by a parser. + *

+ * Methods are visited in the following sequential order : init(), visitFile(), visitNode(), leaveNode(), leaveFile() + * and destroy() + */ +public abstract class SquidAstVisitor implements CodeVisitor, AstVisitor { + + private final List astNodeTypesToVisit = new ArrayList(); + private SquidAstVisitorContext context = null; + + /** + * This method can't be overridden. Used by AstScanners to inject contexts into the actual visitors. + */ + public void setContext(SquidAstVisitorContext context) { + if (this.context != null) { + throw new IllegalStateException("setContext() must only be called once."); + } + this.context = context; + } + + /** + * This method can't be overridden. Returns the injected context, which the visitors can use. + */ + public SquidAstVisitorContext getContext() { + return context; + } + + /** + * This method can't be overridden. The method subscribeTo(AstNodeType... astNodeTypes) must be used to while + * overriding the public void + * init() method. + */ + @Override + public List getAstNodeTypesToVisit() { + return astNodeTypesToVisit; + } + + /** + * This method must called into the init() method when an AST visitor wants to subscribe to a set of AST node type. + */ + public void subscribeTo(AstNodeType... astNodeTypes) { + for (AstNodeType type : astNodeTypes) { + astNodeTypesToVisit.add(type); + } + } + + /** + * Initialize the visitor. This is the time to verify that the visitor has everything required to perform it job. This + * method is called + * once. + */ + public void init() { + } + + /** + * @param astNode AST node or null in case of parse error + */ + @Override + public void visitFile(@Nullable AstNode astNode) { + } + + /** + * {@inheritDoc} + */ + @Override + public void visitNode(AstNode astNode) { + } + + /** + * {@inheritDoc} + */ + @Override + public void leaveNode(AstNode astNode) { + } + + /** + * @param astNode AST node or null in case of parse error + */ + @Override + public void leaveFile(@Nullable AstNode astNode) { + } + + /** + * Destroy the visitor. It is being retired from service. + */ + public void destroy() { + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SquidAstVisitorContext.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SquidAstVisitorContext.java new file mode 100644 index 0000000000..df93c236b5 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SquidAstVisitorContext.java @@ -0,0 +1,98 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.Token; +import java.io.File; +import java.util.List; +import org.sonar.api.batch.fs.InputFile; +import org.sonar.cxx.squidbridge.api.CheckMessage; +import org.sonar.cxx.squidbridge.api.CodeCheck; +import org.sonar.cxx.squidbridge.api.SourceCode; + +public abstract class SquidAstVisitorContext { + + public abstract File getFile(); + + public abstract InputFile getInputFile(); + + public abstract String getInputFileContent(); + + public abstract List getInputFileLines(); + + public abstract G getGrammar(); + + public abstract void addSourceCode(SourceCode child); + + public abstract void popSourceCode(); + + public abstract SourceCode peekSourceCode(); + + public abstract CommentAnalyser getCommentAnalyser(); + + /** + * Create a new file violation + * + * @param check the check which is creating this new violation (i.e. this function's caller) + * @param message message describing the violation, can be formatted (see java.text.MessageFormat) + * @param messageParameters optional message parameters (see java.text.MessageFormat) + */ + public abstract void createFileViolation(CodeCheck check, String message, Object... messageParameters); + + /** + * Create a new line violation caused by a given AST node + * + * @param check the check which is creating this new violation (i.e. this function's caller) + * @param message message describing the violation, can be formatted (see java.text.MessageFormat) + * @param node AST node which causing the violation + * @param messageParameters optional message parameters (see java.text.MessageFormat) + */ + public abstract void createLineViolation(CodeCheck check, String message, AstNode node, Object... messageParameters); + + /** + * Create a new line violation caused by a given token + * + * @param check the check which is creating this new violation (i.e. this function's caller) + * @param message message describing the violation, can be formatted (see java.text.MessageFormat) + * @param token Token which causing the violation + * @param messageParameters optional message parameters (see java.text.MessageFormat) + */ + public abstract void createLineViolation(CodeCheck check, String message, Token token, Object... messageParameters); + + /** + * Create a new line violation, not directly caused by an AST node nor a Token + * + * @param check the check which is creating this new violation (i.e. this function's caller) + * @param message message describing the violation, can be formatted (see java.text.MessageFormat) + * @param line line on which the violation must be created. + * If zero or a negative number is passed, a file violation will be created instead of a line one + * @param messageParameters optional message parameters (see java.text.MessageFormat) + */ + public abstract void createLineViolation(CodeCheck check, String message, int line, Object... messageParameters); + + public abstract void log(CheckMessage message); + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SquidAstVisitorContextImpl.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SquidAstVisitorContextImpl.java new file mode 100644 index 0000000000..33d9f2e289 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/SquidAstVisitorContextImpl.java @@ -0,0 +1,220 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.Token; +import java.io.File; +import java.io.IOException; +import java.util.ArrayDeque; +import java.util.Arrays; +import java.util.Deque; +import java.util.List; +import org.sonar.api.batch.fs.InputFile; +import org.sonar.cxx.squidbridge.api.CheckMessage; +import org.sonar.cxx.squidbridge.api.CodeCheck; +import org.sonar.cxx.squidbridge.api.SourceCode; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceProject; +import org.sonar.cxx.squidbridge.measures.MetricDef; + +public class SquidAstVisitorContextImpl extends SquidAstVisitorContext { + + private final Deque sourceCodeStack = new ArrayDeque(); + private G grammar; + private File file; + private InputFile inputFile; + private final SourceProject project; + private CommentAnalyser commentAnalyser; + + public SquidAstVisitorContextImpl(SourceProject project) { + if (project == null) { + throw new IllegalArgumentException("project cannot be null."); + } + + this.project = project; + sourceCodeStack.push(project); + } + + public void setGrammar(G grammar) { + this.grammar = grammar; + } + + public void setCommentAnalyser(CommentAnalyser commentAnalyser) { + this.commentAnalyser = commentAnalyser; + } + + /** + * {@inheritDoc} + */ + @Override + public CommentAnalyser getCommentAnalyser() { + return commentAnalyser; + } + + /** + * {@inheritDoc} + */ + @Override + public void addSourceCode(SourceCode child) { + peekSourceCode().addChild(child); + sourceCodeStack.push(child); + } + + /** + * {@inheritDoc} + */ + @Override + public void popSourceCode() { + sourceCodeStack.pop(); + } + + /** + * {@inheritDoc} + */ + @Override + public SourceCode peekSourceCode() { + return sourceCodeStack.peek(); + } + + public void setFile(File file, MetricDef filesMetric) { + popTillSourceProject(); + this.file = file; + SourceFile sourceFile = new SourceFile(file.getAbsolutePath(), file.getName()); + addSourceCode(sourceFile); + peekSourceCode().setMeasure(filesMetric, 1); + } + + public void setInputFile(InputFile inputFile, MetricDef filesMetric) { + this.inputFile = inputFile; + setFile(new File(inputFile.uri().getPath()), filesMetric); + } + + protected void popTillSourceProject() { + while (!(peekSourceCode() instanceof SourceProject)) { + popSourceCode(); + } + } + + /** + * {@inheritDoc} + */ + @Override + public File getFile() { + return file; + } + + /** + * {@inheritDoc} + */ + @Override + public InputFile getInputFile() { + return inputFile; + } + + /** + * {@inheritDoc} + */ + @Override + public String getInputFileContent() { + try { + return inputFile.contents(); + } catch (IOException e) { + throw new IllegalStateException(e); + } + } + + /** + * {@inheritDoc} + */ + @Override + public List getInputFileLines() { + return Arrays.asList(getInputFileContent().split("(?:\r)?\n|\r", -1)); + } + + public SourceProject getProject() { + return project; + } + + /** + * {@inheritDoc} + */ + @Override + public G getGrammar() { + return grammar; + } + + /** + * {@inheritDoc} + */ + @Override + public void createFileViolation(CodeCheck check, String message, Object... messageParameters) { + createLineViolation(check, message, -1, messageParameters); + } + + /** + * {@inheritDoc} + */ + @Override + public void createLineViolation(CodeCheck check, String message, AstNode node, Object... messageParameters) { + createLineViolation(check, message, node.getToken(), messageParameters); + } + + /** + * {@inheritDoc} + */ + @Override + public void createLineViolation(CodeCheck check, String message, Token token, Object... messageParameters) { + createLineViolation(check, message, token.getLine(), messageParameters); + } + + /** + * {@inheritDoc} + */ + @Override + public void createLineViolation(CodeCheck check, String message, int line, Object... messageParameters) { + CheckMessage checkMessage = new CheckMessage((Object) check, message, messageParameters); + if (line > 0) { + checkMessage.setLine(line); + } + log(checkMessage); + } + + /** + * {@inheritDoc} + */ + @Override + public void log(CheckMessage message) { + if (peekSourceCode() instanceof SourceFile) { + peekSourceCode().log(message); + } else if (peekSourceCode().getParent(SourceFile.class) != null) { + peekSourceCode().getParent(SourceFile.class).log(message); + } else { + throw new IllegalStateException("Unable to log a check message on source code '" + + (peekSourceCode() == null ? "[NULL]" : peekSourceCode().getKey()) + "'"); + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/ActivatedByDefault.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/ActivatedByDefault.java new file mode 100644 index 0000000000..3ab2e12543 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/ActivatedByDefault.java @@ -0,0 +1,35 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +public @interface ActivatedByDefault { + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedProfileBuilder.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedProfileBuilder.java new file mode 100644 index 0000000000..53ae5177f9 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedProfileBuilder.java @@ -0,0 +1,74 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +import org.sonar.api.profiles.ProfileDefinition; +import org.sonar.api.profiles.RulesProfile; +import org.sonar.api.rules.Rule; +import org.sonar.api.rules.RuleFinder; +import org.sonar.api.utils.AnnotationUtils; +import org.sonar.api.utils.ValidationMessages; + +/** + * Utility class to build an instance of {@link RulesProfile} based on a list of classes annotated + * with {@link ActivatedByDefault}. It can be used to implement the createProfile + * method of {@link ProfileDefinition}. + * + * @since 2.5 + */ +public class AnnotationBasedProfileBuilder { + + private final RuleFinder ruleFinder; + + public AnnotationBasedProfileBuilder(RuleFinder ruleFinder) { + this.ruleFinder = ruleFinder; + } + + public RulesProfile build(String repositoryKey, String profileName, String language, Iterable annotatedClasses, + ValidationMessages messages) { + RulesProfile profile = RulesProfile.create(profileName, language); + for (Class ruleClass : annotatedClasses) { + addRule(ruleClass, profile, repositoryKey, messages); + } + return profile; + } + + private void addRule(Class ruleClass, RulesProfile profile, String repositoryKey, ValidationMessages messages) { + if (AnnotationUtils.getAnnotation(ruleClass, ActivatedByDefault.class) != null) { + org.sonar.check.Rule ruleAnnotation = AnnotationUtils.getAnnotation(ruleClass, org.sonar.check.Rule.class); + if (ruleAnnotation == null) { + messages.addWarningText("Class " + ruleClass + " has no Rule annotation"); + return; + } + String ruleKey = ruleAnnotation.key(); + Rule rule = ruleFinder.findByKey(repositoryKey, ruleKey); + if (rule == null) { + messages.addWarningText("Rule not found: [repository=" + repositoryKey + ", key=" + ruleKey + "]"); + } else { + profile.activateRule(rule, null); + } + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedRulesDefinition.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedRulesDefinition.java new file mode 100644 index 0000000000..a329e94f14 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedRulesDefinition.java @@ -0,0 +1,198 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Predicates; +import com.google.common.collect.Iterables; +import com.google.common.collect.Lists; +import com.google.common.collect.Sets; +import java.lang.annotation.Annotation; +import java.net.URL; +import java.util.*; +import org.apache.commons.lang.StringUtils; +import org.sonar.api.server.rule.*; +import org.sonar.api.server.rule.RulesDefinition.NewParam; +import org.sonar.api.server.rule.RulesDefinition.NewRepository; +import org.sonar.api.server.rule.RulesDefinition.NewRule; +import org.sonar.api.utils.AnnotationUtils; +import org.sonar.check.Cardinality; +import org.sonar.check.Rule; +import org.sonar.check.RuleProperty; +import org.sonar.cxx.squidbridge.rules.ExternalDescriptionLoader; + +/** + * Utility class which helps setting up an implementation of {@link RulesDefinition} with a list of + * rule classes annotated with {@link Rule}, {@link RuleProperty} and SQALE annotations: + *

    + *
  • {@link SqaleSubCharacteristic}
  • + *
  • Exactly one of: + *
      + *
    • {@link SqaleConstantRemediation}
    • + *
    • {@link SqaleLinearRemediation}
    • + *
    • {@link SqaleLinearWithOffsetRemediation}
    • + *
    + *
  • + *
+ * Names and descriptions are also retrieved based on the legacy SonarQube conventions: + *
    + *
  • Rule names and rule property descriptions can be defined in a property file: + * /org/sonar/l10n/[languageKey].properties
  • + *
  • HTML rule descriptions can be defined in individual resources: + * /org/sonar/l10n/[languageKey]/rules/[repositoryKey]/ruleKey.html
  • + *
+ * + * @since 2.5 + */ +public class AnnotationBasedRulesDefinition { + + private final NewRepository repository; + private final String languageKey; + private final ExternalDescriptionLoader externalDescriptionLoader; + + /** + * Adds annotated rule classes to an instance of NewRepository. Fails if one the classes has no SQALE annotation. + */ + public static void load(NewRepository repository, String languageKey, Iterable ruleClasses) { + new AnnotationBasedRulesDefinition(repository, languageKey).addRuleClasses(true, ruleClasses); + } + + public AnnotationBasedRulesDefinition(NewRepository repository, String languageKey) { + this.repository = repository; + this.languageKey = languageKey; + String externalDescriptionBasePath = String.format("/org/sonar/l10n/%s/rules/%s", languageKey, repository.key()); + this.externalDescriptionLoader = new ExternalDescriptionLoader(repository, externalDescriptionBasePath); + } + + public void addRuleClasses(boolean failIfSqaleNotFound, Iterable ruleClasses) { + addRuleClasses(failIfSqaleNotFound, true, ruleClasses); + } + + public void addRuleClasses(boolean failIfSqaleNotFound, boolean failIfNoExplicitKey, Iterable ruleClasses) { + new RulesDefinitionAnnotationLoader().load(repository, Iterables.toArray(ruleClasses, Class.class)); + List newRules = Lists.newArrayList(); + for (Class ruleClass : ruleClasses) { + NewRule rule = newRule(ruleClass, failIfNoExplicitKey); + externalDescriptionLoader.addHtmlDescription(rule); + rule.setTemplate(AnnotationUtils.getAnnotation(ruleClass, RuleTemplate.class) != null); + if (!isSqaleAnnotated(ruleClass) && failIfSqaleNotFound) { + throw new IllegalArgumentException("No SqaleSubCharacteristic annotation was found on " + ruleClass); + } + try { + setupSqaleModel(rule, ruleClass); + } catch (RuntimeException e) { + throw new IllegalArgumentException("Could not setup SQALE model on " + ruleClass, e); + } + newRules.add(rule); + } + setupExternalNames(newRules); + } + + private boolean isSqaleAnnotated(Class ruleClass) { + return getSqaleSubCharAnnotation(ruleClass) != null || getNoSqaleAnnotation(ruleClass) != null; + } + + @VisibleForTesting + NewRule newRule(Class ruleClass, boolean failIfNoExplicitKey) { + org.sonar.check.Rule ruleAnnotation = AnnotationUtils.getAnnotation(ruleClass, org.sonar.check.Rule.class); + if (ruleAnnotation == null) { + throw new IllegalArgumentException("No Rule annotation was found on " + ruleClass); + } + String ruleKey = ruleAnnotation.key(); + if (StringUtils.isEmpty(ruleKey)) { + if (failIfNoExplicitKey) { + throw new IllegalArgumentException("No key is defined in Rule annotation of " + ruleClass); + } + ruleKey = ruleClass.getCanonicalName(); + } + NewRule rule = repository.rule(ruleKey); + if (rule == null) { + throw new IllegalStateException("No rule was created for " + ruleClass + " in " + repository); + } + if (ruleAnnotation.cardinality() == Cardinality.MULTIPLE) { + throw new IllegalArgumentException("Cardinality is not supported, use the RuleTemplate annotation instead"); + } + return rule; + } + + private void setupExternalNames(Collection rules) { + URL resource = AnnotationBasedRulesDefinition.class.getResource("/org/sonar/l10n/" + languageKey + ".properties"); + if (resource == null) { + return; + } + ResourceBundle bundle = ResourceBundle.getBundle("org.sonar.l10n." + languageKey, Locale.ENGLISH); + for (NewRule rule : rules) { + String baseKey = "rule." + repository.key() + "." + rule.key(); + String nameKey = baseKey + ".name"; + if (bundle.containsKey(nameKey)) { + rule.setName(bundle.getString(nameKey)); + } + for (NewParam param : rule.params()) { + String paramDescriptionKey = baseKey + ".param." + param.key(); + if (bundle.containsKey(paramDescriptionKey)) { + param.setDescription(bundle.getString(paramDescriptionKey)); + } + } + } + } + + private void setupSqaleModel(NewRule rule, Class ruleClass) { + SqaleSubCharacteristic subChar = getSqaleSubCharAnnotation(ruleClass); + if (subChar != null) { + rule.setDebtSubCharacteristic(subChar.value()); + } + + SqaleConstantRemediation constant = AnnotationUtils.getAnnotation(ruleClass, SqaleConstantRemediation.class); + SqaleLinearRemediation linear = AnnotationUtils.getAnnotation(ruleClass, SqaleLinearRemediation.class); + SqaleLinearWithOffsetRemediation linearWithOffset = AnnotationUtils.getAnnotation(ruleClass, + SqaleLinearWithOffsetRemediation.class); + + Set remediations = Sets.newHashSet(constant, linear, linearWithOffset); + if (Iterables.size(Iterables.filter(remediations, Predicates.notNull())) > 1) { + throw new IllegalArgumentException("Found more than one SQALE remediation annotations on " + ruleClass); + } + + if (constant != null) { + rule.setDebtRemediationFunction(rule.debtRemediationFunctions().constantPerIssue(constant.value())); + } + if (linear != null) { + rule.setDebtRemediationFunction(rule.debtRemediationFunctions().linear(linear.coeff())); + rule.setEffortToFixDescription(linear.effortToFixDescription()); + } + if (linearWithOffset != null) { + rule.setDebtRemediationFunction( + rule.debtRemediationFunctions().linearWithOffset(linearWithOffset.coeff(), linearWithOffset.offset())); + rule.setEffortToFixDescription(linearWithOffset.effortToFixDescription()); + } + } + + private SqaleSubCharacteristic getSqaleSubCharAnnotation(Class ruleClass) { + return AnnotationUtils.getAnnotation(ruleClass, SqaleSubCharacteristic.class); + } + + private NoSqale getNoSqaleAnnotation(Class ruleClass) { + return AnnotationUtils.getAnnotation(ruleClass, NoSqale.class); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/NoSqale.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/NoSqale.java new file mode 100644 index 0000000000..378ccbd6a3 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/NoSqale.java @@ -0,0 +1,34 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +public @interface NoSqale { +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/RuleTemplate.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/RuleTemplate.java new file mode 100644 index 0000000000..b655aed75b --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/RuleTemplate.java @@ -0,0 +1,35 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +public @interface RuleTemplate { + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleConstantRemediation.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleConstantRemediation.java new file mode 100644 index 0000000000..22f370703a --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleConstantRemediation.java @@ -0,0 +1,40 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +public @interface SqaleConstantRemediation { + + /** + * e.g. "10min" or "2h" + */ + String value(); + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleLinearRemediation.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleLinearRemediation.java new file mode 100644 index 0000000000..ad121ecfea --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleLinearRemediation.java @@ -0,0 +1,39 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +public @interface SqaleLinearRemediation { + + String coeff(); + + String effortToFixDescription(); + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleLinearWithOffsetRemediation.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleLinearWithOffsetRemediation.java new file mode 100644 index 0000000000..5ef5de7a31 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleLinearWithOffsetRemediation.java @@ -0,0 +1,41 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +public @interface SqaleLinearWithOffsetRemediation { + + String coeff(); + + String offset(); + + String effortToFixDescription(); + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleSubCharacteristic.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleSubCharacteristic.java new file mode 100644 index 0000000000..d1fc8229ab --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/SqaleSubCharacteristic.java @@ -0,0 +1,41 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import org.sonar.api.server.rule.RulesDefinition.SubCharacteristics; + +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +public @interface SqaleSubCharacteristic { + + /** + * @see SubCharacteristics + */ + public String value(); + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/Tags.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/Tags.java new file mode 100644 index 0000000000..0d62f08f42 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/Tags.java @@ -0,0 +1,65 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +/** + * @deprecated since 2.6. Each plugin should define its own list of tags. + */ +@Deprecated +public class Tags { + + public static final String ACCESSIBILITY = "accessibility"; + public static final String ASSEMBLER = "assembler"; + public static final String BRAIN_OVERLOAD = "brain-overload"; + public static final String BUG = "bug"; + public static final String CERT = "cert"; + public static final String CLUMSY = "clumsy"; + public static final String CONVENTION = "convention"; + public static final String CROSS_BROWSER = "cross-browser"; + public static final String CWE = "cwe"; + public static final String ERROR_HANDLING = "error-handling"; + public static final String HTML5 = "html5"; + public static final String JAVA7 = "java7"; + public static final String JAVA8 = "java8"; + public static final String MISRA = "misra"; + public static final String MISRA_C = "misra-c"; + public static final String MISRA_CPP = "misra-c++"; + public static final String MULTI_THREADING = "multi-threading"; + public static final String OBSOLETE = "obsolete"; + public static final String OWASP_TOP10 = "owasp-top10"; + public static final String PERFORMANCE = "performance"; + public static final String PITFALL = "pitfall"; + public static final String PREPROCESSOR = "preprocessor"; + public static final String PSR1 = "psr1"; + public static final String PSR2 = "psr2"; + public static final String SECURITY = "security"; + public static final String SQL = "sql"; + public static final String UNUSED = "unused"; + public static final String USER_EXPERIENCE = "user-experience"; + + private Tags() { + // This class only defines constants + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/package-info.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/package-info.java new file mode 100644 index 0000000000..026068039c --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/annotations/package-info.java @@ -0,0 +1,24 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/AnalysisException.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/AnalysisException.java new file mode 100644 index 0000000000..1276d46d57 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/AnalysisException.java @@ -0,0 +1,40 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +public class AnalysisException extends RuntimeException { + + public AnalysisException(String arg0, Throwable arg1) { + super(arg0, arg1); + } + + public AnalysisException(String arg0) { + super(arg0); + } + + public AnalysisException(Throwable arg0) { + super(arg0); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CheckMessage.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CheckMessage.java new file mode 100644 index 0000000000..ec0650aef2 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CheckMessage.java @@ -0,0 +1,128 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import java.text.MessageFormat; +import java.util.Locale; +import org.apache.commons.lang.builder.ToStringBuilder; +import org.sonar.check.Message; + +public class CheckMessage implements Message { + + private Integer line; + private Double cost; + private SourceCode sourceCode; + private final Object check; + private final String defaultMessage; + private final Object[] messageArguments; + private Boolean bypassExclusion; + + public CheckMessage(Object check, String message, Object... messageArguments) { + this.check = check; + this.defaultMessage = message; + this.messageArguments = messageArguments; + } + + /** + * @deprecated replaced by the other constructor since 2.12. See SONAR-2875. + */ + @Deprecated + public CheckMessage(CodeCheck check, String message, Object... messageArguments) { + this((Object) check, message, messageArguments); + } + + public void setSourceCode(SourceCode sourceCode) { + this.sourceCode = sourceCode; + } + + public SourceCode getSourceCode() { + return sourceCode; + } + + public void setLine(int line) { + this.line = line; + } + + @Override + public Integer getLine() { + return line; + } + + public void setCost(double cost) { + this.cost = cost; + } + + public Double getCost() { + return cost; + } + + public void setBypassExclusion(boolean bypassExclusion) { + this.bypassExclusion = bypassExclusion; + } + + public boolean isBypassExclusion() { + return bypassExclusion == null ? false : bypassExclusion; + } + + /** + * @deprecated replaced by getCheck() since SQ version 2.12. Warning, to be called only if check is CodeCheck. + */ + @Override + @Deprecated + public CodeCheck getChecker() { + return (CodeCheck) check; + } + + public Object getCheck() { + return check; + } + + public String getDefaultMessage() { + return defaultMessage; + } + + public Object[] getMessageArguments() { + return messageArguments; + } + + @Override + public String getText(Locale locale) { + return formatDefaultMessage(); + } + + @Override + public String toString() { + return new ToStringBuilder(this).append("source", sourceCode).append("check", check).append("msg", defaultMessage) + .append("line", line).toString(); + } + + public String formatDefaultMessage() { + if (messageArguments.length == 0) { + return defaultMessage; + } else { + return MessageFormat.format(defaultMessage, messageArguments); + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CodeCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CodeCheck.java new file mode 100644 index 0000000000..d5e980fb3a --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CodeCheck.java @@ -0,0 +1,34 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +/** + * @deprecated since SQ version 2.12. See https://jira.codehaus.org/browse/SONAR-2875 + */ +@Deprecated +public interface CodeCheck extends CodeVisitor { + + String getKey(); + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CodeScanner.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CodeScanner.java new file mode 100644 index 0000000000..db90c1cb5e --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CodeScanner.java @@ -0,0 +1,43 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; + +public abstract class CodeScanner { + + private final List visitors = new ArrayList(); + + public abstract Collection> getVisitorClasses(); + + public void accept(CodeVisitor visitor) { + visitors.add(visitor); + } + + public List getVisitors() { + return (List) visitors; + } +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CodeVisitor.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CodeVisitor.java new file mode 100644 index 0000000000..29247f07d8 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/CodeVisitor.java @@ -0,0 +1,28 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +public interface CodeVisitor { + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/Query.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/Query.java new file mode 100644 index 0000000000..deba1cc8e7 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/Query.java @@ -0,0 +1,29 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +public interface Query { + + boolean match(SourceCode unit); +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceClass.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceClass.java new file mode 100644 index 0000000000..7be99d159f --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceClass.java @@ -0,0 +1,49 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +public class SourceClass extends SourceCode { + + /** + * This is used only for Java for now, but can be used for other languages. So maybe we should push it down to + * SourceCode. + */ + private boolean suppressWarnings = false; + + public SourceClass(String key) { + super(key); + } + + public SourceClass(String key, String className) { + super(key, className); + } + + public void setSuppressWarnings(boolean suppressWarnings) { + this.suppressWarnings = suppressWarnings; + } + + public boolean isSuppressWarnings() { + return suppressWarnings; + } +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCode.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCode.java new file mode 100644 index 0000000000..e524eb79db --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCode.java @@ -0,0 +1,297 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import java.util.HashSet; +import java.util.Set; +import java.util.SortedSet; +import java.util.TreeSet; +import javax.annotation.Nullable; +import org.sonar.cxx.squidbridge.measures.Measurable; +import org.sonar.cxx.squidbridge.measures.Measures; +import org.sonar.cxx.squidbridge.measures.Metric; +import org.sonar.cxx.squidbridge.measures.MetricDef; + +public abstract class SourceCode implements Measurable, Comparable { + + private final String name; + private final Measures measures = new Measures(); + private final String key; + private int startAtLine = -1; + private int endAtLine = -1; + private SourceCode parent; + private SortedSet children; + private SourceCodeIndexer indexer; + private Set messages; + + public SourceCode(String key) { + this(key, null); + } + + public SourceCode(String key, @Nullable String name) { + this.key = key; + this.name = name; + } + + public String getKey() { + return key; + } + + @Override + public int compareTo(SourceCode resource) { + return key.compareTo(resource.getKey()); + } + + public String getName() { + return name; + } + + public final void setSourceCodeIndexer(SourceCodeIndexer indexer) { + this.indexer = indexer; + } + + private void index(SourceCode sourceCode) { + if (indexer != null) { + indexer.index(sourceCode); + } + } + + @Override + public boolean equals(Object obj) { + return obj instanceof SourceCode && key.equals(((SourceCode) obj).key); + } + + @Override + public int hashCode() { + return key.hashCode(); + } + + @Override + public String toString() { + return getKey(); + } + + public boolean isType(Class resourceType) { + return this.getClass() == resourceType; + } + + /** + * {@inheritDoc} + */ + @Override + public int getInt(MetricDef metric) { + return (int) getMeasure(metric); + } + + /** + * @deprecated since SQ version 2.1. It's replaced by getInt(MetricDef). It's still defined for binary compatibility. + */ + @Deprecated + public int getInt(Metric metric) { + return (int) getMeasure(metric); + } + + /** + * {@inheritDoc} + */ + @Override + public double getDouble(MetricDef metric) { + return getMeasure(metric); + } + + /** + * @deprecated since SQ version 2.1. It's replaced by getDouble(MetricDef). It's still defined for binary + * compatibility. + */ + @Deprecated + public double getDouble(Metric metric) { + return getMeasure(metric); + } + + public void add(MetricDef metric, SourceCode child) { + add(metric, child.getMeasure(metric)); + } + + public void add(MetricDef metric, double value) { + setMeasure(metric, getMeasure(metric) + value); + } + + public void addData(MetricDef metric, Object data) { + measures.setData(metric, data); + } + + public Object getData(MetricDef metric) { + return measures.getData(metric); + } + + /** + * @deprecated since SQ version 2.1. It's replaced by getData(MetricDef). It's still defined for binary compatibility. + */ + @Deprecated + public Object getData(Metric metric) { + return measures.getData(metric); + } + + private double getMeasure(MetricDef metric) { + if (metric.isCalculatedMetric()) { + return metric.getCalculatedMetricFormula().calculate(this); + } + return measures.getValue(metric); + } + + /** + * {@inheritDoc} + */ + @Override + public void setMeasure(MetricDef metric, double measure) { + if (metric.isCalculatedMetric()) { + throw new IllegalStateException("It's not allowed to set the value of a calculated metric : " + metric.getName()); + } + measures.setValue(metric, measure); + } + + /** + * {@inheritDoc} + */ + @Override + public void setMeasure(MetricDef metric, int measure) { + setMeasure(metric, (double) measure); + } + + public void removeMeasure(MetricDef metric) { + measures.removeMeasure(metric); + } + + public void setStartAtLine(int startAtLine) { + this.startAtLine = startAtLine; + this.endAtLine = startAtLine; + } + + public void setEndAtLine(int endAtLine) { + this.endAtLine = endAtLine; + } + + public int getStartAtLine() { + return startAtLine; + } + + public int getEndAtLine() { + return endAtLine; + } + + public SourceCode addChild(SourceCode sourceCode) { + if (children == null) { + children = new TreeSet(); + } + sourceCode.setParent(this); + if (!children.contains(sourceCode)) { + children.add(sourceCode); + index(sourceCode); + } + return this; + } + + public S getParent(Class sourceCode) { + if (parent == null) { + return null; + } + if (parent.getClass().equals(sourceCode)) { + return (S) parent; + } + return parent.getParent(sourceCode); + } + + public S getAncestor(Class withClass) { + S ancestor = getParent(withClass); + if (ancestor != null) { + S parentAncestor = ancestor.getAncestor(withClass); + if (parentAncestor != null) { + ancestor = parentAncestor; + } + } + return ancestor; + } + + public void log(CheckMessage message) { + message.setSourceCode(this); + getCheckMessages().add(message); + } + + public Set getCheckMessages() { + if (messages == null) { + messages = new HashSet(); + } + return messages; + } + + public boolean hasCheckMessages() { + return messages != null && !messages.isEmpty(); + } + + public SourceCode getFirstChild() { + return !children.isEmpty() ? children.first() : null; + } + + public SourceCode getLastChild() { + return !children.isEmpty() ? children.last() : null; + } + + private void setParent(SourceCode parent) { + this.parent = parent; + } + + public SourceCode getParent() { + return parent; + } + + public Set getChildren() { + return children; + } + + public boolean hasChild(SourceCode squidUnit) { + if (!hasChildren()) { + return false; + } + if (children.contains(squidUnit)) { + return true; + } + for (SourceCode child : children) { + if (child.hasChild(squidUnit)) { + return true; + } + } + return false; + } + + public boolean hasChildren() { + return children != null && !children.isEmpty(); + } + + public boolean hasAmongParents(SourceCode expectedParent) { + if (parent == null) { + return false; + } + return parent.equals(expectedParent) || parent.hasAmongParents(expectedParent); + } +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCodeIndexer.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCodeIndexer.java new file mode 100644 index 0000000000..e389569965 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCodeIndexer.java @@ -0,0 +1,29 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +public interface SourceCodeIndexer { + + void index(SourceCode sourceCode); +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCodeSearchEngine.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCodeSearchEngine.java new file mode 100644 index 0000000000..7684af4146 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCodeSearchEngine.java @@ -0,0 +1,33 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import java.util.Collection; + +public interface SourceCodeSearchEngine { + + SourceCode search(String key); + + Collection search(Query... query); +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCodeTreeDecorator.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCodeTreeDecorator.java new file mode 100644 index 0000000000..e59b30aecd --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceCodeTreeDecorator.java @@ -0,0 +1,59 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import org.sonar.cxx.squidbridge.measures.MetricDef; + +public class SourceCodeTreeDecorator { + + private final SourceProject project; + + public SourceCodeTreeDecorator(SourceProject project) { + this.project = project; + } + + public void decorateWith(MetricDef... metrics) { + decorateWith(project, metrics); + } + + private void decorateWith(SourceCode sourceCode, MetricDef... metrics) { + if (sourceCode.hasChildren()) { + for (SourceCode child : sourceCode.getChildren()) { + decorateWith(child, metrics); + } + } + for (MetricDef metric : metrics) { + if (!metric.aggregateIfThereIsAlreadyAValue() && Double.doubleToRawLongBits(sourceCode.getDouble(metric)) != 0) { + continue; + } + if (sourceCode.hasChildren()) { + for (SourceCode child : sourceCode.getChildren()) { + if (!metric.isCalculatedMetric() && metric.isThereAggregationFormula()) { + sourceCode.add(metric, child); + } + } + } + } + } +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceFile.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceFile.java new file mode 100644 index 0000000000..3bfe140ee7 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceFile.java @@ -0,0 +1,59 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import java.util.HashSet; +import java.util.Set; + +public class SourceFile extends SourceCode { + + private final Set noSonarTagLines = new HashSet(); + + public SourceFile(String key) { + super(key); + setStartAtLine(1); + } + + public SourceFile(String key, String fileName) { + super(key, fileName); + setStartAtLine(1); + } + + public Set getNoSonarTagLines() { + return noSonarTagLines; + } + + public boolean hasNoSonarTagAtLine(int lineNumber) { + return noSonarTagLines.contains(lineNumber); + } + + public void addNoSonarTagLines(Set noSonarTagLines) { + this.noSonarTagLines.addAll(noSonarTagLines); + } + + public void addNoSonarTagLine(int line) { + noSonarTagLines.add(line); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceFunction.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceFunction.java new file mode 100644 index 0000000000..7f34eefe4f --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceFunction.java @@ -0,0 +1,36 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +public class SourceFunction extends SourceCode { + + public SourceFunction(String key) { + super(key); + } + + public SourceFunction(SourceFile sourceFile, String functionSignature, int startAtLine) { + super(sourceFile.getKey() + "#" + functionSignature, functionSignature); + setStartAtLine(startAtLine); + } +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceMethod.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceMethod.java new file mode 100644 index 0000000000..4a74ff3159 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceMethod.java @@ -0,0 +1,56 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import org.sonar.cxx.squidbridge.measures.Metric; + +public class SourceMethod extends SourceCode { + + /** + * This is used only for Java for now, but can be used for other languages. So maybe we should push it down to + * SourceCode. + */ + private boolean suppressWarnings = false; + + public SourceMethod(String key) { + super(key); + } + + public SourceMethod(SourceClass peekParentClass, String methodSignature, int startAtLine) { + super(peekParentClass.getKey() + "#" + methodSignature, methodSignature); + setStartAtLine(startAtLine); + } + + public boolean isAccessor() { + return getInt(Metric.ACCESSORS) != 0; + } + + public void setSuppressWarnings(boolean suppressWarnings) { + this.suppressWarnings = suppressWarnings; + } + + public boolean isSuppressWarnings() { + return suppressWarnings; + } +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourcePackage.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourcePackage.java new file mode 100644 index 0000000000..5a110e5bdc --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourcePackage.java @@ -0,0 +1,31 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +public class SourcePackage extends SourceCode { + + public SourcePackage(String key) { + super(key); + } +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceProject.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceProject.java new file mode 100644 index 0000000000..ca44350652 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SourceProject.java @@ -0,0 +1,32 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +public class SourceProject extends SourceCode { + + public SourceProject(String key) { + super(key); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SquidConfiguration.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SquidConfiguration.java new file mode 100644 index 0000000000..3a6c3911cb --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/SquidConfiguration.java @@ -0,0 +1,52 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import java.nio.charset.Charset; + +public class SquidConfiguration { + + private Charset charset = Charset.defaultCharset(); + private boolean stopSquidOnException = false; + + public SquidConfiguration() { + } + + public SquidConfiguration(Charset charset) { + this.charset = charset; + } + + public Charset getCharset() { + return charset; + } + + public void setStopSquidOnException(boolean stopSquidOnException) { + this.stopSquidOnException = stopSquidOnException; + } + + public boolean stopSquidOnException() { + return stopSquidOnException; + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/package-info.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/package-info.java new file mode 100644 index 0000000000..ca23d3dd70 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/api/package-info.java @@ -0,0 +1,25 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +@javax.annotation.ParametersAreNonnullByDefault +package org.sonar.cxx.squidbridge.api; diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractCommentRegularExpressionCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractCommentRegularExpressionCheck.java new file mode 100644 index 0000000000..2bd13c4324 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractCommentRegularExpressionCheck.java @@ -0,0 +1,71 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import static com.google.common.base.Preconditions.checkNotNull; +import com.google.common.base.Strings; +import com.sonar.sslr.api.AstAndTokenVisitor; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.Token; +import com.sonar.sslr.api.Trivia; +import java.util.regex.Pattern; +import org.sonar.api.utils.SonarException; + +public abstract class AbstractCommentRegularExpressionCheck extends SquidCheck implements + AstAndTokenVisitor { + + private Pattern pattern = null; + + // See SONAR-3164 + public abstract String getRegularExpression(); + + // See SONAR-3164 + public abstract String getMessage(); + + @Override + public void init() { + String regularExpression = getRegularExpression(); + checkNotNull(regularExpression, "getRegularExpression() should not return null"); + + if (!Strings.isNullOrEmpty(regularExpression)) { + try { + pattern = Pattern.compile(regularExpression, Pattern.DOTALL); + } catch (RuntimeException e) { + throw new SonarException("Unable to compile regular expression: " + regularExpression, e); + } + } + } + + @Override + public void visitToken(Token token) { + if (pattern != null) { + for (Trivia trivia : token.getTrivia()) { + if (trivia.isComment() && pattern.matcher(trivia.getToken().getOriginalValue()).matches()) { + getContext().createLineViolation(this, getMessage(), trivia.getToken()); + } + } + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractFileComplexityCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractFileComplexityCheck.java new file mode 100644 index 0000000000..57e2b1d9a1 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractFileComplexityCheck.java @@ -0,0 +1,57 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.Grammar; +import org.sonar.api.utils.SonarException; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.measures.MetricDef; + +public abstract class AbstractFileComplexityCheck extends SquidCheck { + + // See SONAR-3164 + public abstract int getMaximumFileComplexity(); + + public abstract MetricDef getComplexityMetric(); + + @Override + public void init() { + if (getMaximumFileComplexity() <= 0) { + throw new SonarException("The complexity threshold must be set to a value greater than 0, but given: " + + getMaximumFileComplexity()); + } + } + + @Override + public void leaveFile(AstNode astNode) { + SourceFile sourceFile = (SourceFile) getContext().peekSourceCode(); + int fileComplexity = ChecksHelper.getRecursiveMeasureInt(sourceFile, getComplexityMetric()); + if (fileComplexity > getMaximumFileComplexity()) { + getContext().createFileViolation(this, "The file is too complex ({0} while maximum allowed is set to {1}).", + fileComplexity, getMaximumFileComplexity()); + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractGotoCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractGotoCheck.java new file mode 100644 index 0000000000..e890f69509 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractGotoCheck.java @@ -0,0 +1,44 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; + +public abstract class AbstractGotoCheck extends SquidCheck { + + public abstract AstNodeType getGotoRule(); + + @Override + public void init() { + subscribeTo(getGotoRule()); + } + + @Override + public void visitNode(AstNode astNode) { + getContext().createLineViolation(this, "Goto should be avoided.", astNode); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractLineLengthCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractLineLengthCheck.java new file mode 100644 index 0000000000..50b4cedab9 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractLineLengthCheck.java @@ -0,0 +1,62 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstAndTokenVisitor; +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.Token; +import org.sonar.api.utils.SonarException; + +public abstract class AbstractLineLengthCheck extends SquidCheck implements AstAndTokenVisitor { + + private int lastIncorrectLine; + + // See SONAR-3164 + public abstract int getMaximumLineLength(); + + @Override + public void init() { + if (getMaximumLineLength() <= 0) { + throw new SonarException("The maximal line length must be set to a value greater than 0, but given: " + + getMaximumLineLength()); + } + } + + @Override + public void visitFile(AstNode astNode) { + lastIncorrectLine = -1; + } + + @Override + public void visitToken(Token token) { + if (!token.isGeneratedCode() && lastIncorrectLine != token.getLine() && token.getColumn() + token.getValue() + .length() > getMaximumLineLength()) { + lastIncorrectLine = token.getLine(); + getContext().createLineViolation(this, "The line length is greater than {0,number,integer} authorized.", token + .getLine(), getMaximumLineLength()); + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractMagicCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractMagicCheck.java new file mode 100644 index 0000000000..50a2b8aaef --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractMagicCheck.java @@ -0,0 +1,91 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import java.util.Set; + +public abstract class AbstractMagicCheck extends SquidCheck { + + private AstNodeType[] inclusions; + private AstNodeType[] exclusions; + + private int inclusionLevel; + private int exclusionLevel; + + public abstract Set getPatterns(); + + public abstract Set getInclusions(); + + public abstract Set getExclusions(); + + public abstract String getMessage(); + + public abstract boolean isExcepted(AstNode candidate); + + @Override + public void visitFile(AstNode fileNode) { + inclusionLevel = 0; + exclusionLevel = 0; + } + + @Override + public void init() { + Set patternsSet = getPatterns(); + AstNodeType[] patterns = patternsSet.toArray(new AstNodeType[patternsSet.size()]); + + Set inclusionsSet = getInclusions(); + inclusions = inclusionsSet.toArray(new AstNodeType[inclusionsSet.size()]); + + Set exclusionsSet = getExclusions(); + exclusions = exclusionsSet.toArray(new AstNodeType[exclusionsSet.size()]); + + subscribeTo(patterns); + subscribeTo(inclusions); + subscribeTo(exclusions); + } + + @Override + public void visitNode(AstNode astNode) { + if (astNode.is(inclusions)) { + inclusionLevel++; + } else if (astNode.is(exclusions)) { + exclusionLevel++; + } else if ((inclusions.length == 0 || inclusionLevel > 0) && exclusionLevel == 0 && !isExcepted(astNode)) { + getContext().createLineViolation(this, getMessage(), astNode); + } + } + + @Override + public void leaveNode(AstNode astNode) { + if (astNode.is(inclusions)) { + inclusionLevel--; + } else if (astNode.is(exclusions)) { + exclusionLevel--; + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNamingCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNamingCheck.java new file mode 100644 index 0000000000..9ab09e382f --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNamingCheck.java @@ -0,0 +1,78 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import static com.google.common.base.Preconditions.checkArgument; +import static com.google.common.base.Preconditions.checkNotNull; +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import java.util.regex.Pattern; +import org.sonar.api.utils.SonarException; + +public abstract class AbstractNamingCheck extends SquidCheck { + + private Pattern pattern; + + public abstract AstNodeType[] getRules(); + + public abstract String getName(AstNode astNode); + + public abstract String getRegexp(); + + public abstract String getMessage(String name); + + public abstract boolean isExcluded(AstNode astNode); + + @Override + public void init() { + AstNodeType[] rules = getRules(); + checkNotNull(rules, "getRules() must not return null"); + checkArgument(rules.length > 0, "getRules() must return at least one rule"); + + subscribeTo(getRules()); + + String regexp = getRegexp(); + checkNotNull(regexp, "getRegexp() must not return null"); + + try { + this.pattern = Pattern.compile(regexp); + } catch (Exception e) { + throw new SonarException("Unable to compile regular expression: " + regexp, e); + } + } + + @Override + public void visitNode(AstNode astNode) { + if (!isExcluded(astNode)) { + String name = getName(astNode); + checkNotNull(name, "getName() must not return null"); + + if (!pattern.matcher(name).matches()) { + getContext().createLineViolation(this, getMessage(name), astNode); + } + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNestedCommentsCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNestedCommentsCheck.java new file mode 100644 index 0000000000..8b620b856c --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNestedCommentsCheck.java @@ -0,0 +1,53 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstAndTokenVisitor; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.Token; +import com.sonar.sslr.api.Trivia; +import java.util.Set; + +public abstract class AbstractNestedCommentsCheck extends SquidCheck implements AstAndTokenVisitor { + + public abstract Set getCommentStartTags(); + + @Override + public void visitToken(Token token) { + for (Trivia trivia : token.getTrivia()) { + if (trivia.isComment()) { + String contents = getContext().getCommentAnalyser().getContents(trivia.getToken().getOriginalValue()); + + for (String commentStartTag : getCommentStartTags()) { + if (contents.contains(commentStartTag)) { + getContext().createLineViolation(this, "This comments contains the nested comment start tag \"{0}\"", trivia + .getToken(), commentStartTag); + break; + } + } + } + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNestedIfCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNestedIfCheck.java new file mode 100644 index 0000000000..a29b8b1063 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNestedIfCheck.java @@ -0,0 +1,71 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import org.sonar.api.utils.SonarException; + +public abstract class AbstractNestedIfCheck extends SquidCheck { + + private int nestingLevel; + + // See SONAR-3164 + public abstract int getMaximumNestingLevel(); + + public abstract AstNodeType getIfRule(); + + @Override + public void visitFile(AstNode astNode) { + nestingLevel = 0; + } + + @Override + public void init() { + if (getMaximumNestingLevel() <= 0) { + throw new SonarException("The maximal if nesting level must be set to a value greater than 0, but given: " + + getMaximumNestingLevel()); + } + subscribeTo(getIfRule()); + } + + @Override + public void visitNode(AstNode astNode) { + nestingLevel++; + if (nestingLevel == getMaximumNestingLevel() + 1) { + getContext().createLineViolation(this, + "This if has a nesting level of {0}, which is higher than the maximum allowed {1}.", + astNode, + nestingLevel, + getMaximumNestingLevel()); + } + } + + @Override + public void leaveNode(AstNode astNode) { + nestingLevel--; + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNoSonarCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNoSonarCheck.java new file mode 100644 index 0000000000..505de00b25 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractNoSonarCheck.java @@ -0,0 +1,57 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstAndTokenVisitor; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.Token; +import com.sonar.sslr.api.Trivia; +import org.sonar.cxx.squidbridge.api.CheckMessage; + +public abstract class AbstractNoSonarCheck extends SquidCheck implements AstAndTokenVisitor { + + @Override + public void visitToken(Token token) { + for (Trivia trivia : token.getTrivia()) { + if (trivia.isComment()) { + String[] commentLines = getContext().getCommentAnalyser().getContents(trivia.getToken().getOriginalValue()) + .split("(\r)?\n|\r", -1); + int line = trivia.getToken().getLine(); + + for (String commentLine : commentLines) { + if (commentLine.contains("NOSONAR")) { + CheckMessage violation = new CheckMessage((Object) this, + "Is NOSONAR usage acceptable or does it hide a real quality flaw?"); + violation.setLine(line); + violation.setBypassExclusion(true); + getContext().log(violation); + } + + line++; + } + } + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractOneStatementPerLineCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractOneStatementPerLineCheck.java new file mode 100644 index 0000000000..ba15dcf91c --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractOneStatementPerLineCheck.java @@ -0,0 +1,75 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.google.common.collect.Maps; +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import java.util.Map; + +public abstract class AbstractOneStatementPerLineCheck extends SquidCheck { + + private final Map statementsPerLine = Maps.newHashMap(); + + public abstract AstNodeType getStatementRule(); + + public abstract boolean isExcluded(AstNode statementNode); + + @Override + public void init() { + subscribeTo(getStatementRule()); + } + + @Override + public void visitFile(AstNode astNode) { + statementsPerLine.clear(); + } + + @Override + public void visitNode(AstNode statementNode) { + if (!isExcluded(statementNode)) { + int line = statementNode.getTokenLine(); + + if (!statementsPerLine.containsKey(line)) { + statementsPerLine.put(line, 0); + } + + statementsPerLine.put(line, statementsPerLine.get(line) + 1); + } + } + + @Override + public void leaveFile(AstNode astNode) { + for (Map.Entry statementsAtLine : statementsPerLine.entrySet()) { + if (statementsAtLine.getValue() > 1) { + getContext().createLineViolation(this, + "At most one statement is allowed per line, but {0} statements were found on this line.", + statementsAtLine.getKey(), + statementsAtLine.getValue()); + } + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractParseErrorCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractParseErrorCheck.java new file mode 100644 index 0000000000..14e08a32b6 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractParseErrorCheck.java @@ -0,0 +1,47 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.RecognitionException; +import java.io.PrintWriter; +import java.io.StringWriter; +import org.sonar.cxx.squidbridge.AstScannerExceptionHandler; + +public abstract class AbstractParseErrorCheck extends SquidCheck implements + AstScannerExceptionHandler { + + @Override + public void processRecognitionException(RecognitionException e) { + getContext().createLineViolation(this, e.getMessage(), e.getLine()); + } + + @Override + public void processException(Exception e) { + StringWriter exception = new StringWriter(); + e.printStackTrace(new PrintWriter(exception)); + getContext().createLineViolation(this, exception.toString(), 1); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractSingleLineCommentsSyntaxCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractSingleLineCommentsSyntaxCheck.java new file mode 100644 index 0000000000..dbd6ff5065 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractSingleLineCommentsSyntaxCheck.java @@ -0,0 +1,53 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstAndTokenVisitor; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.Token; +import com.sonar.sslr.api.Trivia; +import org.apache.commons.lang.StringUtils; + +public abstract class AbstractSingleLineCommentsSyntaxCheck extends SquidCheck implements + AstAndTokenVisitor { + + public abstract String getSingleLineCommentSyntaxPrefix(); + + @Override + public void visitToken(Token token) { + for (Trivia trivia : token.getTrivia()) { + if (trivia.isComment() && trivia.getToken().getLine() < token.getLine()) { + String comment = trivia.getToken().getOriginalValue(); + + if (!comment.startsWith(getSingleLineCommentSyntaxPrefix()) && !StringUtils.containsAny(comment, "\r\n")) { + getContext().createLineViolation(this, + "This single line comment should use the single line comment syntax \"{0}\"", + trivia.getToken(), + getSingleLineCommentSyntaxPrefix()); + } + } + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractXPathCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractXPathCheck.java new file mode 100644 index 0000000000..f3f0134445 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/AbstractXPathCheck.java @@ -0,0 +1,72 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.google.common.base.Strings; +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.xpath.api.AstNodeXPathQuery; +import java.util.List; +import org.sonar.api.utils.SonarException; + +public abstract class AbstractXPathCheck extends SquidCheck { + + private AstNodeXPathQuery query = null; + + // See SONAR-3164 + public abstract String getXPathQuery(); + + // See SONAR-3164 + public abstract String getMessage(); + + @Override + public void init() { + String xpath = getXPathQuery(); + if (!Strings.isNullOrEmpty(xpath)) { + try { + query = AstNodeXPathQuery.create(getXPathQuery()); + } catch (RuntimeException e) { + throw new SonarException("Unable to initialize the XPath engine, perhaps because of an invalid query: " + xpath, + e); + } + } + } + + @Override + public void visitFile(AstNode fileNode) { + if (query != null && fileNode != null) { + List objects = query.selectNodes(fileNode); + + for (Object object : objects) { + if (object instanceof AstNode) { + AstNode astNode = (AstNode) object; + getContext().createLineViolation(this, getMessage(), astNode.getTokenLine()); + } else if (object instanceof Boolean && (Boolean) object) { + getContext().createFileViolation(this, getMessage()); + } + } + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifier.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifier.java new file mode 100644 index 0000000000..09e0c36a16 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifier.java @@ -0,0 +1,143 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.google.common.base.Objects; +import com.google.common.collect.Ordering; +import java.util.Collection; +import java.util.Comparator; +import java.util.Iterator; +import java.util.Locale; +import javax.annotation.Nullable; +import org.hamcrest.Matcher; +import static org.junit.Assert.assertThat; +import org.sonar.cxx.squidbridge.api.CheckMessage; + +/** + * Helper class for testing checks without having to deploy them on a Sonar instance. + * It can be used as following: + *
{@code
+ * CheckMessagesVerifier.verify(messages)
+ *   .next().atLine(1).withMessage("foo")
+ *   .next().atLine(2).withMessage("bar")
+ *   .noMore();
+ * }
+ * Strictly speaking this is just a wrapper over collection of {@link CheckMessage}, + * which guarantees order of traversal. + * + * @see CheckMessagesVerifierRule + * @since sslr-squid-bridge 2.1 + */ +public final class CheckMessagesVerifier { + + private final Iterator iterator; + private CheckMessage current; + + private static final Comparator ORDERING = new Comparator() { + @Override + public int compare(CheckMessage left, CheckMessage right) { + if (Objects.equal(left.getLine(), right.getLine())) { + return left.getDefaultMessage().compareTo(right.getDefaultMessage()); + } else if (left.getLine() == null) { + return -1; + } else if (right.getLine() == null) { + return 1; + } else { + return left.getLine().compareTo(right.getLine()); + } + } + }; + + private CheckMessagesVerifier(Collection messages) { + iterator = Ordering.from(ORDERING).sortedCopy(messages).iterator(); + } + + public static CheckMessagesVerifier verify(Collection messages) { + return new CheckMessagesVerifier(messages); + } + + public CheckMessagesVerifier next() { + if (!iterator.hasNext()) { + throw new AssertionError("\nExpected violation"); + } + current = iterator.next(); + return this; + } + + public void noMore() { + if (iterator.hasNext()) { + CheckMessage next = iterator.next(); + throw new AssertionError("\nNo more violations expected\ngot: at line " + next.getLine()); + } + } + + private void checkStateOfCurrent() { + if (current == null) { + throw new IllegalStateException("Prior to this method you should call next()"); + } + } + + public CheckMessagesVerifier atLine(@Nullable Integer expectedLine) { + checkStateOfCurrent(); + if (!Objects.equal(expectedLine, current.getLine())) { + throw assertionError(expectedLine, current.getLine()); + } + return this; + } + + public CheckMessagesVerifier withMessage(String expectedMessage) { + checkStateOfCurrent(); + String actual = current.getText(Locale.ENGLISH); + if (!actual.equals(expectedMessage)) { + throw assertionError("\"" + expectedMessage + "\"", "\"" + actual + "\""); + } + return this; + } + + /** + * Note that this method requires JUnit and Hamcrest. + */ + public CheckMessagesVerifier withMessageThat(Matcher matcher) { + checkStateOfCurrent(); + String actual = current.getText(Locale.ENGLISH); + assertThat(actual, matcher); + return this; + } + + /** + * @since sslr-squid-bridge 2.3 + */ + public CheckMessagesVerifier withCost(Double expectedCost) { + checkStateOfCurrent(); + if (!Objects.equal(expectedCost, current.getCost())) { + throw assertionError(expectedCost, current.getCost()); + } + return this; + } + + private static AssertionError assertionError(Object expected, Object actual) { + return new AssertionError("\nExpected: " + expected + "\ngot: " + actual); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifierRule.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifierRule.java new file mode 100644 index 0000000000..912bda1368 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifierRule.java @@ -0,0 +1,65 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.google.common.collect.Lists; +import java.util.Collection; +import java.util.List; +import org.junit.rules.Verifier; +import org.sonar.cxx.squidbridge.api.CheckMessage; + +/** + * This JUnit Rule allows to automatically execute {@link CheckMessagesVerifier#noMore()}. + *
+ * @org.junit.Rule
+ * public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule();
+ *
+ * @org.junit.Test
+ * public void test() {
+ *   checkMessagesVerifier.verify(messages)
+ *     .next().atLine(1)
+ *     .next().atLine(2);
+ * }
+ * 
+ * + * @since sslr-squid-bridge 2.1 + */ +public class CheckMessagesVerifierRule extends Verifier { + + private final List verifiers = Lists.newArrayList(); + + public CheckMessagesVerifier verify(Collection messages) { + CheckMessagesVerifier verifier = CheckMessagesVerifier.verify(messages); + verifiers.add(verifier); + return verifier; + } + + @Override + protected void verify() { + for (CheckMessagesVerifier verifier : verifiers) { + verifier.noMore(); + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/ChecksHelper.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/ChecksHelper.java new file mode 100644 index 0000000000..31c720a722 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/ChecksHelper.java @@ -0,0 +1,46 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import org.sonar.cxx.squidbridge.api.SourceCode; +import org.sonar.cxx.squidbridge.measures.MetricDef; + +public final class ChecksHelper { + + private ChecksHelper() { + } + + public static int getRecursiveMeasureInt(SourceCode sourceCode, MetricDef metric) { + int childrenValue = 0; + + if (sourceCode.getChildren() != null) { + for (SourceCode child : sourceCode.getChildren()) { + childrenValue += getRecursiveMeasureInt(child, metric); + } + } + + return sourceCode.getInt(metric) + childrenValue; + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/SquidCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/SquidCheck.java new file mode 100644 index 0000000000..f824bbdb2f --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/SquidCheck.java @@ -0,0 +1,37 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.Grammar; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.api.CodeCheck; + +public abstract class SquidCheck extends SquidAstVisitor implements CodeCheck { + + @Override + public String getKey() { + return null; + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/ViolationCounterCheck.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/ViolationCounterCheck.java new file mode 100644 index 0000000000..2b5cd2d030 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/ViolationCounterCheck.java @@ -0,0 +1,309 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.google.common.base.Throwables; +import com.google.common.collect.Maps; +import com.google.common.collect.Sets; +import com.google.common.collect.TreeMultiset; +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.Grammar; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.ObjectInputStream; +import java.io.ObjectOutputStream; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; +import org.apache.commons.io.IOUtils; +import org.apache.commons.lang.StringUtils; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.api.CheckMessage; + +public class ViolationCounterCheck extends SquidAstVisitor { + + private final ViolationCounter violationCounter; + private final String projectsDirCanonicalPath; + + public static class ViolationCounter { + + private final Map>> violationsByFileAndRule; + + public ViolationCounter() { + this.violationsByFileAndRule = new HashMap>>(); + } + + private ViolationCounter(Map>> violationsByFileAndRule) { + this.violationsByFileAndRule = violationsByFileAndRule; + } + + public void increment(String fileRelativePath, String rule, int line) { + if (!violationsByFileAndRule.containsKey(fileRelativePath)) { + violationsByFileAndRule.put(fileRelativePath, new HashMap>()); + } + Map> violationsByRule = violationsByFileAndRule.get(fileRelativePath); + + if (!violationsByRule.containsKey(rule)) { + violationsByRule.put(rule, TreeMultiset.create()); + } + TreeMultiset violations = violationsByRule.get(rule); + + violations.add(line); + } + + public void saveToFile(String destinationFilePath) { + FileOutputStream fos = null; + ObjectOutputStream oos = null; + try { + fos = new FileOutputStream(destinationFilePath); + oos = new ObjectOutputStream(fos); + oos.writeObject(this.violationsByFileAndRule); + } catch (Exception e) { + throw Throwables.propagate(e); + } finally { + IOUtils.closeQuietly(fos); + IOUtils.closeQuietly(oos); + } + } + + public static ViolationCounter loadFromFile(File sourceFile) { + if (!sourceFile.exists() || sourceFile.length() == 0) { + return new ViolationCounter(); + } else { + FileInputStream fis = null; + ObjectInputStream ois = null; + try { + fis = new FileInputStream(sourceFile); + ois = new ObjectInputStream(fis); + return new ViolationCounter((Map>>) ois.readObject()); + } catch (Exception e) { + throw Throwables.propagate(e); + } finally { + IOUtils.closeQuietly(fis); + IOUtils.closeQuietly(ois); + } + } + } + } + + public static class ViolationDifferenceAnalyzer { + + private final ViolationCounter expected; + private final ViolationCounter actual; + private boolean hasDifferences = false; + + public ViolationDifferenceAnalyzer(ViolationCounter expected, ViolationCounter actual) { + this.expected = expected; + this.actual = actual; + } + + private static void println() { + System.out.println(); + } + + private static void println(String msg) { + System.out.println(msg); + } + + public void printReport() { + println(); + println(); + println("********************************"); + println("* Violation differences report *"); + println("********************************"); + println(); + println(); + printDifferencesByFile(); + println(); + println(); + printDifferencesByRule(); + println(); + println(); + println("*****************"); + println("* End of report *"); + println("*****************"); + println(); + println(); + } + + private void printDifferencesByFile() { + println("Differences by file:"); + + Set> handledFilesRules = Sets.newHashSet(); + + for (String file : expected.violationsByFileAndRule.keySet()) { + boolean shouldPrintHeader = true; + for (String rule : expected.violationsByFileAndRule.get(file).keySet()) { + handledFilesRules.add(Maps.immutableEntry(file, rule)); + shouldPrintHeader = printDifferencesByFileAndRule(shouldPrintHeader, file, rule); + } + } + + for (String file : actual.violationsByFileAndRule.keySet()) { + boolean shouldPrintHeader = true; + for (String rule : actual.violationsByFileAndRule.get(file).keySet()) { + if (handledFilesRules.contains(Maps.immutableEntry(file, rule))) { + continue; + } + shouldPrintHeader = printDifferencesByFileAndRule(shouldPrintHeader, file, rule); + } + } + + println("End of differences by file."); + } + + private static void printDifferencesByFileHeader(String file) { + println(" File " + file + ":"); + } + + private boolean printDifferencesByFileAndRule(boolean shouldPrintHeader, String file, String rule) { + + TreeMultiset linesExpected = getLines(expected, file, rule); + TreeMultiset linesActual = getLines(actual, file, rule); + + if (!linesExpected.equals(linesActual)) { + hasDifferences = true; + + if (shouldPrintHeader) { + printDifferencesByFileHeader(file); + } + + println(" " + rule + ", (difference only) expected (" + + StringUtils.join(setDifference(linesExpected, linesActual), ",") + "), actual (" + + StringUtils.join(setDifference(linesActual, linesExpected), ",") + ")."); + + return false; + } else { + return shouldPrintHeader; + } + + } + + private static TreeMultiset getLines(ViolationCounter counter, String file, String rule) { + if (!counter.violationsByFileAndRule.containsKey(file) + || !counter.violationsByFileAndRule.get(file).containsKey(rule)) { + return TreeMultiset.create(); + } else { + return counter.violationsByFileAndRule.get(file).get(rule); + } + } + + private static TreeMultiset setDifference(TreeMultiset a, TreeMultiset b) { + TreeMultiset aMinusB = TreeMultiset.create(a); + aMinusB.removeAll(b); + return aMinusB; + } + + private void printDifferencesByRule() { + println("Differences by rule:"); + + for (String rule : getRules()) { + int expectedViolations = getViolationsByRule(expected, rule); + int actualViolations = getViolationsByRule(actual, rule); + + println(" " + rule + " expected: " + expectedViolations + ", actual: " + actualViolations + ": " + + (expectedViolations == actualViolations ? "OK" : "*** FAILURE ***")); + } + + println("End of differences by rule."); + } + + private Set getRules() { + Set rules = new HashSet(); + + for (String file : expected.violationsByFileAndRule.keySet()) { + rules.addAll(expected.violationsByFileAndRule.get(file).keySet()); + } + + for (String file : actual.violationsByFileAndRule.keySet()) { + rules.addAll(actual.violationsByFileAndRule.get(file).keySet()); + } + + return rules; + } + + private static int getViolationsByRule(ViolationCounter counter, String rule) { + int violations = 0; + + for (String file : counter.violationsByFileAndRule.keySet()) { + if (counter.violationsByFileAndRule.get(file).containsKey(rule)) { + violations += counter.violationsByFileAndRule.get(file).get(rule).size(); + } + } + + return violations; + } + + public boolean hasDifferences() { + return hasDifferences; + } + + } + + public ViolationCounterCheck(String projectsDir, ViolationCounter violationCounter) { + try { + this.projectsDirCanonicalPath = new File(projectsDir).getCanonicalPath(); + } catch (IOException e) { + throw Throwables.propagate(e); + } + + this.violationCounter = violationCounter; + } + + @Override + public void leaveFile(AstNode node) { + Set violationsOnCurrentFile = new HashSet(getContext().peekSourceCode() + .getCheckMessages()); + for (CheckMessage violation : violationsOnCurrentFile) { + violationCounter.increment(getRelativePath(getContext().getFile()), violation.getChecker().getClass() + .getSimpleName(), + violation.getLine() == null ? -1 + : violation.getLine()); + } + } + + private String getRelativePath(File file) { + if (!file.exists()) { + throw new IllegalArgumentException("The file located at \"" + file.getAbsolutePath() + "\" does not exist."); + } + + String canonicalPath; + try { + canonicalPath = file.getCanonicalPath(); + } catch (IOException e) { + throw Throwables.propagate(e); + } + + if (!canonicalPath.startsWith(projectsDirCanonicalPath)) { + throw new IllegalArgumentException("The file located at \"" + canonicalPath + "\" is not within projectsDir (\"" + + projectsDirCanonicalPath + "\")."); + } + + return canonicalPath.substring(projectsDirCanonicalPath.length()).replace('\\', '/'); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/package-info.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/package-info.java new file mode 100644 index 0000000000..a633a3c617 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/checks/package-info.java @@ -0,0 +1,25 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +@javax.annotation.ParametersAreNonnullByDefault +package org.sonar.cxx.squidbridge.checks; diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByMeasure.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByMeasure.java new file mode 100644 index 0000000000..c78d4403df --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByMeasure.java @@ -0,0 +1,74 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.indexer; + +import org.apache.commons.lang.math.NumberUtils; +import org.sonar.cxx.squidbridge.api.Query; +import org.sonar.cxx.squidbridge.api.SourceCode; +import org.sonar.cxx.squidbridge.measures.Metric; +import org.sonar.cxx.squidbridge.measures.MetricDef; + +public class QueryByMeasure implements Query { + + private final MetricDef metric; + private final Operator operator; + private final double value; + + public enum Operator { + GREATER_THAN, EQUALS, GREATER_THAN_EQUALS, LESS_THAN, LESS_THAN_EQUALS + } + + /** + * @deprecated use {@link #QueryByMeasure(MetricDef, Operator, double)} instead + */ + @Deprecated + public QueryByMeasure(Metric metric, Operator operator, double value) { + this((MetricDef) metric, operator, value); + } + + public QueryByMeasure(MetricDef metric, Operator operator, double value) { + this.metric = metric; + this.operator = operator; + this.value = value; + } + + @Override + public boolean match(SourceCode unit) { + switch (operator) { + case EQUALS: + return NumberUtils.compare(unit.getDouble(metric), value) == 0; + case GREATER_THAN: + return unit.getDouble(metric) > value; + case GREATER_THAN_EQUALS: + return unit.getDouble(metric) >= value; + case LESS_THAN_EQUALS: + return unit.getDouble(metric) <= value; + case LESS_THAN: + return unit.getDouble(metric) < value; + default: + throw new IllegalStateException("The operator value '" + operator + "' is unknown."); + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByName.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByName.java new file mode 100644 index 0000000000..bd70544eb7 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByName.java @@ -0,0 +1,70 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.indexer; + +import org.sonar.cxx.squidbridge.api.Query; +import org.sonar.cxx.squidbridge.api.SourceCode; + +public class QueryByName implements Query { + + private final String resourceName; + + public QueryByName(String resourceName) { + if (resourceName == null) { + throw new IllegalStateException("The name can't be null !"); + } + this.resourceName = resourceName; + } + + @Override + public boolean match(SourceCode unit) { + if (unit.getName() != null) { + return unit.getName().equals(resourceName); + } + return false; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (!(o instanceof QueryByName)) { + return false; + } + + QueryByName that = (QueryByName) o; + + if (resourceName != null ? !resourceName.equals(that.resourceName) : that.resourceName != null) { + return false; + } + + return true; + } + + @Override + public int hashCode() { + return resourceName.hashCode(); + } +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByParent.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByParent.java new file mode 100644 index 0000000000..f06a9cc662 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByParent.java @@ -0,0 +1,41 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.indexer; + +import org.sonar.cxx.squidbridge.api.Query; +import org.sonar.cxx.squidbridge.api.SourceCode; + +public class QueryByParent implements Query { + + private final SourceCode parent; + + public QueryByParent(SourceCode parent) { + this.parent = parent; + } + + @Override + public boolean match(SourceCode unit) { + return unit.hasAmongParents(parent); + } +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByType.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByType.java new file mode 100644 index 0000000000..87ff1baf3d --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/QueryByType.java @@ -0,0 +1,67 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.indexer; + +import org.sonar.cxx.squidbridge.api.Query; +import org.sonar.cxx.squidbridge.api.SourceCode; + +public class QueryByType implements Query { + + private final Class resourceType; + + public QueryByType(Class resourceType) { + if (resourceType == null) { + throw new IllegalStateException("The type of resource can't be null !"); + } + this.resourceType = resourceType; + } + + @Override + public boolean match(SourceCode unit) { + return unit.isType(resourceType); + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (!(o instanceof QueryByType)) { + return false; + } + + QueryByType that = (QueryByType) o; + + if (resourceType != null ? !resourceType.equals(that.resourceType) : that.resourceType != null) { + return false; + } + + return true; + } + + @Override + public int hashCode() { + return resourceType != null ? resourceType.hashCode() : 0; + } +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/SquidIndex.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/SquidIndex.java new file mode 100644 index 0000000000..e8d4291fef --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/SquidIndex.java @@ -0,0 +1,72 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.indexer; + +import java.util.Collection; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; +import java.util.TreeMap; +import org.sonar.cxx.squidbridge.api.Query; +import org.sonar.cxx.squidbridge.api.SourceCode; +import org.sonar.cxx.squidbridge.api.SourceCodeIndexer; +import org.sonar.cxx.squidbridge.api.SourceCodeSearchEngine; + +public class SquidIndex implements SourceCodeIndexer, SourceCodeSearchEngine { + + private final Map index = new TreeMap(); + + @Override + public Collection search(Query... query) { + Set result = new HashSet(); + for (SourceCode unit : index.values()) { + if (isSquidUnitMatchQueries(unit, query)) { + result.add(unit); + } + } + return result; + } + + private boolean isSquidUnitMatchQueries(SourceCode unit, Query... queries) { + boolean match; + for (Query query : queries) { + match = query.match(unit); + if (!match) { + return false; + } + } + return true; + } + + @Override + public SourceCode search(String key) { + return index.get(key); + } + + @Override + public void index(SourceCode sourceCode) { + sourceCode.setSourceCodeIndexer(this); + index.put(sourceCode.getKey(), sourceCode); + } +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/package-info.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/package-info.java new file mode 100644 index 0000000000..00af4dee57 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/indexer/package-info.java @@ -0,0 +1,25 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +@javax.annotation.ParametersAreNonnullByDefault +package org.sonar.cxx.squidbridge.indexer; diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/AbstractnessFormula.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/AbstractnessFormula.java new file mode 100644 index 0000000000..0e5afb4e1c --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/AbstractnessFormula.java @@ -0,0 +1,37 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +public class AbstractnessFormula implements CalculatedMetricFormula { + + @Override + public double calculate(Measurable measurable) { + if (Double.doubleToRawLongBits(measurable.getDouble(Metric.CLASSES)) == 0) { + return 0; + } + return (measurable.getDouble(Metric.ABSTRACT_CLASSES) + measurable.getDouble(Metric.INTERFACES)) / measurable + .getDouble(Metric.CLASSES); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/AggregationFormula.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/AggregationFormula.java new file mode 100644 index 0000000000..1857fbca2b --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/AggregationFormula.java @@ -0,0 +1,32 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import java.util.Collection; + +public interface AggregationFormula { + + double aggregate(MetricDef metric, Collection measurables); + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/CalculatedMetricFormula.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/CalculatedMetricFormula.java new file mode 100644 index 0000000000..36635b71c3 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/CalculatedMetricFormula.java @@ -0,0 +1,30 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +public interface CalculatedMetricFormula { + + double calculate(Measurable measurable); + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/CommentLinesDensityFormula.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/CommentLinesDensityFormula.java new file mode 100644 index 0000000000..bbe14e6e2b --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/CommentLinesDensityFormula.java @@ -0,0 +1,38 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +public class CommentLinesDensityFormula implements CalculatedMetricFormula { + + @Override + public double calculate(Measurable measurable) { + double total = measurable.getDouble(Metric.LINES_OF_CODE) + measurable + .getDouble(Metric.COMMENT_LINES_WITHOUT_HEADER); + if (Double.doubleToRawLongBits(total) != 0) { + return measurable.getDouble(Metric.COMMENT_LINES_WITHOUT_HEADER) / total; + } + return 0; + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/CommentLinesWithoutHeaderFormula.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/CommentLinesWithoutHeaderFormula.java new file mode 100644 index 0000000000..43206a811d --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/CommentLinesWithoutHeaderFormula.java @@ -0,0 +1,33 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +public class CommentLinesWithoutHeaderFormula implements CalculatedMetricFormula { + + @Override + public double calculate(Measurable mesurable) { + return mesurable.getInt(Metric.COMMENT_LINES) - mesurable.getInt(Metric.HEADER_COMMENT_LINES); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/DistanceFormula.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/DistanceFormula.java new file mode 100644 index 0000000000..381261f5e9 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/DistanceFormula.java @@ -0,0 +1,33 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +public class DistanceFormula implements CalculatedMetricFormula { + + @Override + public double calculate(Measurable measurable) { + return Math.abs(measurable.getDouble(Metric.ABSTRACTNESS) + measurable.getDouble(Metric.INSTABILITY) - 1); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/InstabilityFormula.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/InstabilityFormula.java new file mode 100644 index 0000000000..f9a27b08f0 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/InstabilityFormula.java @@ -0,0 +1,36 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +public class InstabilityFormula implements CalculatedMetricFormula { + + @Override + public double calculate(Measurable measurable) { + if (Double.doubleToRawLongBits(measurable.getDouble(Metric.CA) + measurable.getDouble(Metric.CE)) == 0) { + return 0; + } + return measurable.getDouble(Metric.CE) / (measurable.getDouble(Metric.CA) + measurable.getDouble(Metric.CE)); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/MeanAggregationFormula.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/MeanAggregationFormula.java new file mode 100644 index 0000000000..186504c287 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/MeanAggregationFormula.java @@ -0,0 +1,39 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import java.util.Collection; + +public class MeanAggregationFormula implements AggregationFormula { + + @Override + public double aggregate(MetricDef metric, Collection measurables) { + if (measurables.isEmpty()) { + return 0; + } + SumAggregationFormula sumFormula = new SumAggregationFormula(); + return sumFormula.aggregate(metric, measurables) / measurables.size(); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/Measurable.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/Measurable.java new file mode 100644 index 0000000000..703fe54c8e --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/Measurable.java @@ -0,0 +1,36 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +public interface Measurable { + + double getDouble(T metric); + + int getInt(T metric); + + void setMeasure(T metric, double measure); + + void setMeasure(T metric, int measure); + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/Measures.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/Measures.java new file mode 100644 index 0000000000..e2b53af4d5 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/Measures.java @@ -0,0 +1,96 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import java.util.IdentityHashMap; +import java.util.Map; + +public class Measures { + + private final Map measures = new IdentityHashMap(); + + public double getValue(MetricDef metric) { + Measure measure = measures.get(metric); + if (measure == null) { + return 0; + } + return measure.getValue(); + } + + public Object getData(MetricDef metric) { + Measure measure = measures.get(metric); + if (measure == null) { + return null; + } + return measure.getData(); + } + + public void setValue(MetricDef metric, double measure) { + getMeasureOrCreateIt(metric).setValue(measure); + } + + public void setData(MetricDef metric, Object data) { + getMeasureOrCreateIt(metric).setData(data); + } + + private Measure getMeasureOrCreateIt(MetricDef metric) { + Measure measure = measures.get(metric); + if (measure == null) { + measure = new Measure(0); + measures.put(metric, measure); + } + return measure; + } + + public void removeMeasure(MetricDef metric) { + measures.remove(metric); + } + + private static final class Measure { + + private double value; + private Object data; + + private Measure(double value) { + this.value = value; + } + + private double getValue() { + return value; + } + + private void setValue(double value) { + this.value = value; + } + + private Object getData() { + return data; + } + + private void setData(Object data) { + this.data = data; + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/Metric.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/Metric.java new file mode 100644 index 0000000000..042d3a5720 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/Metric.java @@ -0,0 +1,86 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +public enum Metric implements MetricDef { + + PACKAGES, CLASSES, ANONYMOUS_INNER_CLASSES, FILES, METHODS, CONSTRUCTORS, STATEMENTS, LINES(false), BLANK_LINES(false), + COMMENT_LINES( + false), HEADER_COMMENT_LINES(false), COMMENTED_OUT_CODE_LINES(false), BRANCHES, PUBLIC_API, PUBLIC_DOC_API, + ACCESSORS, + COMMENT_BLANK_LINES(false), LINES_OF_CODE(false), COMMENT_LINES_WITHOUT_HEADER(new CommentLinesWithoutHeaderFormula()), + PUBLIC_DOCUMENTED_API_DENSITY(new PublicDocumentedApiDensityFormula()), COMMENT_LINES_DENSITY( + new CommentLinesDensityFormula()), + COMPLEXITY, INTERFACES, ABSTRACT_CLASSES, ABSTRACTNESS(new AbstractnessFormula()), CA(new NoAggregationFormula()), CE( + new NoAggregationFormula()), INSTABILITY(new InstabilityFormula()), DISTANCE(new DistanceFormula()), DIT( + new NoAggregationFormula()), + RFC(new NoAggregationFormula()), NOC(new NoAggregationFormula()), LCOM4(new NoAggregationFormula()), LCOM4_BLOCKS; + + private CalculatedMetricFormula formula = null; + + private AggregationFormula aggregationFormula = new SumAggregationFormula(); + + private boolean aggregateIfThereIsAlreadyAValue = true; + + Metric() { + } + + Metric(boolean aggregateIfThereIsAlreadyAValue) { + this.aggregateIfThereIsAlreadyAValue = aggregateIfThereIsAlreadyAValue; + } + + Metric(AggregationFormula aggregationFormula) { + this.aggregationFormula = aggregationFormula; + } + + Metric(CalculatedMetricFormula formula) { + this.formula = formula; + } + + @Override + public String getName() { + return name(); + } + + @Override + public boolean isCalculatedMetric() { + return formula != null; + } + + @Override + public boolean aggregateIfThereIsAlreadyAValue() { + return aggregateIfThereIsAlreadyAValue; + } + + @Override + public boolean isThereAggregationFormula() { + return !(aggregationFormula instanceof NoAggregationFormula); + } + + @Override + public CalculatedMetricFormula getCalculatedMetricFormula() { + return formula; + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/MetricDef.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/MetricDef.java new file mode 100644 index 0000000000..453640047e --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/MetricDef.java @@ -0,0 +1,37 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +public interface MetricDef { + + String getName(); + + boolean isCalculatedMetric(); + + boolean aggregateIfThereIsAlreadyAValue(); + + boolean isThereAggregationFormula(); + + CalculatedMetricFormula getCalculatedMetricFormula(); +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/NoAggregationFormula.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/NoAggregationFormula.java new file mode 100644 index 0000000000..e418467ac9 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/NoAggregationFormula.java @@ -0,0 +1,35 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import java.util.Collection; + +public class NoAggregationFormula implements AggregationFormula { + + @Override + public double aggregate(MetricDef metric, Collection measurables) { + return 0; + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/PublicDocumentedApiDensityFormula.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/PublicDocumentedApiDensityFormula.java new file mode 100644 index 0000000000..acd6c21fa2 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/PublicDocumentedApiDensityFormula.java @@ -0,0 +1,36 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +public class PublicDocumentedApiDensityFormula implements CalculatedMetricFormula { + + @Override + public double calculate(Measurable measurable) { + if (Double.doubleToRawLongBits(measurable.getDouble(Metric.PUBLIC_API)) == 0) { + return 1; + } + return measurable.getDouble(Metric.PUBLIC_DOC_API) / measurable.getDouble(Metric.PUBLIC_API); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/SumAggregationFormula.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/SumAggregationFormula.java new file mode 100644 index 0000000000..b58afcc6eb --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/SumAggregationFormula.java @@ -0,0 +1,39 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import java.util.Collection; + +public class SumAggregationFormula implements AggregationFormula { + + @Override + public double aggregate(MetricDef metric, Collection measurables) { + double aggregation = 0; + for (Measurable measurable : measurables) { + aggregation += measurable.getDouble(metric); + } + return aggregation; + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/package-info.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/package-info.java new file mode 100644 index 0000000000..1bce130a54 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/measures/package-info.java @@ -0,0 +1,25 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +@javax.annotation.ParametersAreNonnullByDefault +package org.sonar.cxx.squidbridge.measures; diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/CommentsVisitor.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/CommentsVisitor.java new file mode 100644 index 0000000000..61e87f37ef --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/CommentsVisitor.java @@ -0,0 +1,143 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.metrics; + +import com.sonar.sslr.api.AstAndTokenVisitor; +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.Token; +import com.sonar.sslr.api.Trivia; +import java.util.HashSet; +import java.util.Set; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.measures.MetricDef; + +/** + * Visitor that computes the number of lines of comments and the number of empty lines of comments. + */ +public final class CommentsVisitor extends SquidAstVisitor implements AstAndTokenVisitor { + + private Set noSonar; + private Set comments; + private boolean seenFirstToken; + + private final boolean enableNoSonar; + private final MetricDef commentMetric; + private final boolean ignoreHeaderComments; + + private CommentsVisitor(CommentsVisitorBuilder builder) { + this.enableNoSonar = builder.enableNoSonar; + this.commentMetric = builder.commentMetric; + this.ignoreHeaderComments = builder.ignoreHeaderComments; + } + + private void addNoSonar(int line) { + comments.remove(line); + noSonar.add(line); + } + + private void addCommentLine(int line) { + if (!noSonar.contains(line)) { + comments.add(line); + } + } + + @Override + public void visitFile(AstNode astNode) { + noSonar = new HashSet(); + comments = new HashSet(); + seenFirstToken = false; + } + + @Override + public void visitToken(Token token) { + if (!ignoreHeaderComments || seenFirstToken) { + for (Trivia trivia : token.getTrivia()) { + if (trivia.isComment()) { + String[] commentLines = getContext().getCommentAnalyser().getContents(trivia.getToken().getOriginalValue()) + .split("(\r)?\n|\r", -1); + int line = trivia.getToken().getLine(); + + for (String commentLine : commentLines) { + if (enableNoSonar && commentLine.contains("NOSONAR")) { + addNoSonar(line); + } else if (commentMetric != null && !getContext().getCommentAnalyser().isBlank(commentLine)) { + addCommentLine(line); + } + + line++; + } + } + } + } + + seenFirstToken = true; + } + + @Override + public void leaveFile(AstNode astNode) { + if (enableNoSonar) { + ((SourceFile) getContext().peekSourceCode()).addNoSonarTagLines(noSonar); + } + if (commentMetric != null) { + getContext().peekSourceCode().add(commentMetric, comments.size()); + } + } + + public static CommentsVisitorBuilder builder() { + return new CommentsVisitorBuilder(); + } + + public static final class CommentsVisitorBuilder { + + private boolean enableNoSonar = false; + private MetricDef commentMetric; + private boolean ignoreHeaderComments = false; + + private CommentsVisitorBuilder() { + } + + public CommentsVisitor build() { + return new CommentsVisitor(this); + } + + public CommentsVisitorBuilder withNoSonar(boolean enableNoSonar) { + this.enableNoSonar = enableNoSonar; + return this; + } + + public CommentsVisitorBuilder withCommentMetric(MetricDef commentMetric) { + this.commentMetric = commentMetric; + return this; + } + + public CommentsVisitorBuilder withIgnoreHeaderComment(boolean ignoreHeaderComments) { + this.ignoreHeaderComments = ignoreHeaderComments; + return this; + } + + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/ComplexityVisitor.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/ComplexityVisitor.java new file mode 100644 index 0000000000..e6e4091b55 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/ComplexityVisitor.java @@ -0,0 +1,113 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.metrics; + +import com.google.common.collect.ImmutableSet; +import com.google.common.collect.Sets; +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import java.util.Collection; +import java.util.Set; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.measures.MetricDef; + +public final class ComplexityVisitor extends SquidAstVisitor { + + private final MetricDef metric; + private final Set astNodeTypes; + private final Set exclusionAstNodeTypes; + + public static final class Builder { + + private MetricDef metric; + private Set astNodeTypes = Sets.newHashSet(); + private Set exclusionAstNodeTypes = Sets.newHashSet(); + + private Builder() { + } + + public Builder setMetricDef(MetricDef metric) { + this.metric = metric; + return this; + } + + public Builder subscribeTo(AstNodeType... astNodeTypes) { + for (AstNodeType astNodeType : astNodeTypes) { + this.astNodeTypes.add(astNodeType); + } + return this; + } + + public Builder subscribeTo(Collection astNodeTypes) { + this.astNodeTypes = Sets.newHashSet(astNodeTypes); + return this; + } + + public Builder setExclusions(Collection exclusionAstNodeTypes) { + this.exclusionAstNodeTypes = Sets.newHashSet(exclusionAstNodeTypes); + return this; + } + + public Builder addExclusions(AstNodeType... exclusionAstNodeTypes) { + for (AstNodeType exclusionAstNodeType : exclusionAstNodeTypes) { + this.exclusionAstNodeTypes.add(exclusionAstNodeType); + } + return this; + } + + public ComplexityVisitor build() { + return new ComplexityVisitor(this); + } + + } + + private ComplexityVisitor(Builder builder) { + this.metric = builder.metric; + this.astNodeTypes = ImmutableSet.copyOf(builder.astNodeTypes); + this.exclusionAstNodeTypes = ImmutableSet.copyOf(builder.exclusionAstNodeTypes); + } + + public static Builder builder() { + return new Builder(); + } + + @Override + public void init() { + for (AstNodeType astNodeType : astNodeTypes) { + subscribeTo(astNodeType); + } + } + + @Override + public void visitNode(AstNode astNode) { + for (AstNodeType exclusionAstNodeType : exclusionAstNodeTypes) { + if (astNode.hasAncestor(exclusionAstNodeType)) { + return; + } + } + getContext().peekSourceCode().add(metric, 1); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/CounterVisitor.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/CounterVisitor.java new file mode 100644 index 0000000000..be9a73caf7 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/CounterVisitor.java @@ -0,0 +1,94 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.metrics; + +import com.google.common.collect.ImmutableSet; +import com.google.common.collect.Sets; +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import java.util.Collection; +import java.util.Set; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.measures.MetricDef; + +public final class CounterVisitor extends SquidAstVisitor { + + private final MetricDef metric; + private final Set astNodeTypes; + + public static final class Builder { + + private MetricDef metric; + private Set astNodeTypes = Sets.newHashSet(); + + private Builder() { + } + + public Builder setMetricDef(MetricDef metric) { + this.metric = metric; + return this; + } + + public Builder subscribeTo(AstNodeType... astNodeTypes) { + for (AstNodeType astNodeType : astNodeTypes) { + this.astNodeTypes.add(astNodeType); + } + + return this; + } + + public Builder subscribeTo(Collection astNodeTypes) { + this.astNodeTypes = Sets.newHashSet(astNodeTypes); + return this; + } + + public CounterVisitor build() { + return new CounterVisitor(this); + } + + } + + private CounterVisitor(Builder builder) { + this.metric = builder.metric; + this.astNodeTypes = ImmutableSet.copyOf(builder.astNodeTypes); + } + + public static Builder builder() { + return new Builder(); + } + + @Override + public void init() { + for (AstNodeType astNodeType : astNodeTypes) { + subscribeTo(astNodeType); + } + } + + @Override + public void visitNode(AstNode astNode) { + getContext().peekSourceCode().add(metric, 1); + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/LinesOfCodeVisitor.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/LinesOfCodeVisitor.java new file mode 100644 index 0000000000..63f47aebfb --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/LinesOfCodeVisitor.java @@ -0,0 +1,70 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.metrics; + +import com.sonar.sslr.api.AstAndTokenVisitor; +import com.sonar.sslr.api.AstNode; +import static com.sonar.sslr.api.GenericTokenType.EOF; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.Token; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.measures.MetricDef; + +/** + * Visitor that computes the number of lines of code of a file. + */ +public class LinesOfCodeVisitor extends SquidAstVisitor implements AstAndTokenVisitor { + + private final MetricDef metric; + private int lastTokenLine; + + public LinesOfCodeVisitor(MetricDef metric) { + this.metric = metric; + } + + /** + * {@inheritDoc} + */ + @Override + public void visitFile(AstNode node) { + lastTokenLine = -1; + } + + /** + * {@inheritDoc} + */ + @Override + public void visitToken(Token token) { + if (!EOF.equals(token.getType())) { + /* Handle all the lines of the token */ + String[] tokenLines = token.getValue().split("\n", -1); + + int firstLineAlreadyCounted = lastTokenLine == token.getLine() ? 1 : 0; + getContext().peekSourceCode().add(metric, tokenLines.length - firstLineAlreadyCounted); + + lastTokenLine = token.getLine() + tokenLines.length - 1; + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/LinesVisitor.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/LinesVisitor.java new file mode 100644 index 0000000000..2dbe3fc056 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/LinesVisitor.java @@ -0,0 +1,54 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.metrics; + +import com.sonar.sslr.api.AstAndTokenVisitor; +import static com.sonar.sslr.api.GenericTokenType.EOF; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.Token; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.measures.MetricDef; + +/** + * Visitor that computes the number of lines of a file. + */ +public class LinesVisitor extends SquidAstVisitor implements AstAndTokenVisitor { + + private final MetricDef metric; + + public LinesVisitor(MetricDef metric) { + this.metric = metric; + } + + /** + * {@inheritDoc} + */ + @Override + public void visitToken(Token token) { + if (EOF.equals(token.getType())) { + getContext().peekSourceCode().setMeasure(metric, token.getLine()); + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/package-info.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/package-info.java new file mode 100644 index 0000000000..45e1e54794 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/metrics/package-info.java @@ -0,0 +1,25 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +@javax.annotation.ParametersAreNonnullByDefault +package org.sonar.cxx.squidbridge.metrics; diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/package-info.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/package-info.java new file mode 100644 index 0000000000..b4bbc86211 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/package-info.java @@ -0,0 +1,25 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +@javax.annotation.ParametersAreNonnullByDefault +package org.sonar.cxx.squidbridge; diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/rules/ExternalDescriptionLoader.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/rules/ExternalDescriptionLoader.java new file mode 100644 index 0000000000..73e954cc2a --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/rules/ExternalDescriptionLoader.java @@ -0,0 +1,67 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.rules; + +import com.google.common.annotations.Beta; +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Charsets; +import com.google.common.io.Resources; +import java.io.IOException; +import java.net.URL; +import org.sonar.api.server.rule.RulesDefinition.NewRepository; +import org.sonar.api.server.rule.RulesDefinition.NewRule; + +@Beta +public class ExternalDescriptionLoader { + + private final String resourceBasePath; + + public ExternalDescriptionLoader(NewRepository repository, String resourceBasePath) { + this.resourceBasePath = resourceBasePath; + } + + public static void loadHtmlDescriptions(NewRepository repository, String languageKey) { + ExternalDescriptionLoader loader = new ExternalDescriptionLoader(repository, languageKey); + for (NewRule newRule : repository.rules()) { + loader.addHtmlDescription(newRule); + } + } + + public void addHtmlDescription(NewRule rule) { + URL resource = ExternalDescriptionLoader.class.getResource(resourceBasePath + "/" + rule.key() + ".html"); + if (resource != null) { + addHtmlDescription(rule, resource); + } + } + + @VisibleForTesting + void addHtmlDescription(NewRule rule, URL resource) { + try { + rule.setHtmlDescription(Resources.toString(resource, Charsets.UTF_8)); + } catch (IOException e) { + throw new IllegalStateException("Failed to read: " + resource, e); + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/rules/PropertyFileLoader.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/rules/PropertyFileLoader.java new file mode 100644 index 0000000000..28bb85af5e --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/rules/PropertyFileLoader.java @@ -0,0 +1,73 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.rules; + +import com.google.common.annotations.Beta; +import java.io.IOException; +import java.io.InputStream; +import java.util.Properties; +import org.sonar.api.server.rule.RulesDefinition.NewParam; +import org.sonar.api.server.rule.RulesDefinition.NewRepository; +import org.sonar.api.server.rule.RulesDefinition.NewRule; + +@Beta +public class PropertyFileLoader { + + private PropertyFileLoader() { + // This class should not be instantiated + } + + public static void loadNames(NewRepository repository, String resourceAbsolutePath) { + InputStream stream = PropertyFileLoader.class.getResourceAsStream(resourceAbsolutePath); + if (stream == null) { + throw new IllegalArgumentException("Cound not find resource: " + resourceAbsolutePath); + } + loadNames(repository, stream); + } + + public static void loadNames(NewRepository repository, InputStream stream) { + Properties properties = new Properties(); + try { + properties.load(stream); + } catch (IOException e) { + throw new IllegalArgumentException("Could not read names from properties", e); + } + for (NewRule rule : repository.rules()) { + String baseKey = "rule." + repository.key() + "." + rule.key(); + String nameKey = baseKey + ".name"; + String ruleName = properties.getProperty(nameKey); + if (ruleName != null) { + rule.setName(ruleName); + } + for (NewParam param : rule.params()) { + String paramDescriptionKey = baseKey + ".param." + param.key(); + String paramDescription = properties.getProperty(paramDescriptionKey); + if (paramDescription != null) { + param.setDescription(paramDescription); + } + } + } + } + +} diff --git a/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/rules/package-info.java b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/rules/package-info.java new file mode 100644 index 0000000000..65cb0da355 --- /dev/null +++ b/cxx-squid-bridge/src/main/java/org/sonar/cxx/squidbridge/rules/package-info.java @@ -0,0 +1,24 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.rules; diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/MyCodeScanner.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/MyCodeScanner.java new file mode 100644 index 0000000000..37defac97e --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/MyCodeScanner.java @@ -0,0 +1,37 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import java.util.ArrayList; +import java.util.Collection; +import org.sonar.cxx.squidbridge.api.CodeScanner; +import org.sonar.cxx.squidbridge.api.CodeVisitor; + +public class MyCodeScanner extends CodeScanner { + + @Override + public Collection> getVisitorClasses() { + return new ArrayList>(); + } +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/ProgressAstScannerTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/ProgressAstScannerTest.java new file mode 100644 index 0000000000..8c0e69951e --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/ProgressAstScannerTest.java @@ -0,0 +1,159 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import ch.qos.logback.classic.spi.LoggingEvent; +import ch.qos.logback.core.Appender; +import com.google.common.base.Throwables; +import com.jayway.awaitility.Awaitility; +import com.jayway.awaitility.Duration; +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.impl.Parser; +import com.sonar.sslr.test.minic.MiniCParser; +import java.io.File; +import java.util.Arrays; +import java.util.Collection; +import java.util.concurrent.CountDownLatch; +import org.junit.Test; +import org.mockito.ArgumentMatcher; +import static org.mockito.Matchers.any; +import static org.mockito.Matchers.argThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.verifyNoMoreInteractions; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.sonar.cxx.squidbridge.api.SourceProject; +import org.sonar.cxx.squidbridge.test.miniC.MiniCAstScanner.MiniCMetrics; + +public class ProgressAstScannerTest { + + @Test + public void test() throws Exception { + SquidAstVisitorContextImpl context = new SquidAstVisitorContextImpl(new SourceProject("")); + Parser parser = MiniCParser.create(); + AstScanner scanner = new ProgressAstScanner.Builder(context) + .setBaseParser(parser) + .setFilesMetric(MiniCMetrics.FILES) + .build(); + + ch.qos.logback.classic.Logger root = (ch.qos.logback.classic.Logger) LoggerFactory + .getLogger(Logger.ROOT_LOGGER_NAME); + @SuppressWarnings("unchecked") + Appender mockAppender = mock(Appender.class); + root.addAppender(mockAppender); + + scanner.scanFile(new File("src/test/resources/metrics/lines.mc")); + + verify(mockAppender).doAppend(argThat(new ArgumentMatcher() { + @Override + public boolean matches(final Object argument) { + return ((LoggingEvent) argument).getFormattedMessage().contains("1 source files to be analyzed"); + } + })); + } + + @Test(timeout = 5000) + public void testInterrupt() throws Exception { + SquidAstVisitorContextImpl context = new SquidAstVisitorContextImpl(new SourceProject("")); + CountDownLatch latch = new CountDownLatch(1); + ProgressReport progress = mock(ProgressReport.class); + Parser parser = new BlockingParser(latch); + + AstScanner scanner = new ProgressAstScanner.Builder(context) + .setProgressReport(progress) + .setBaseParser(parser) + .setFilesMetric(MiniCMetrics.FILES) + .build(); + + File[] files = {new File("src/test/resources/metrics/lines.mc"), new File("src/test/resources/metrics/lines2.mc")}; + ScannerRunner runner = new ScannerRunner(scanner, files); + runner.start(); + + // wait for first parsing to start + latch.await(); + verify(progress).start(any(Collection.class)); + + runner.interrupt(); + Awaitility.waitAtMost(Duration.TWO_SECONDS).until(new AssertProgressReportCancelled(progress)); + verifyNoMoreInteractions(progress); + } + + private class AssertProgressReportCancelled implements Runnable { + + private final ProgressReport progress; + + AssertProgressReportCancelled(ProgressReport progress) { + this.progress = progress; + } + + public void run() { + verify(progress).cancel(); + } + } + + private static class BlockingParser extends Parser { + + private final CountDownLatch latch; + + protected BlockingParser(CountDownLatch latch) { + super(null); + this.latch = latch; + } + + @Override + public AstNode parse(File f) { + latch.countDown(); + try { + Thread.sleep(10_000); + } catch (InterruptedException e) { + throw Throwables.propagate(e); + } + return null; + } + } + + private static class ScannerRunner extends Thread { + + private AstScanner scanner; + private File[] f; + + ScannerRunner(AstScanner scanner, File[] f) { + this.setName("TestScannerRunner"); + this.scanner = scanner; + this.f = f; + } + + @Override + public void run() { + try { + scanner.scanFiles(Arrays.asList(f)); + } catch (Exception e) { + e.printStackTrace(); + } + } + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/ProgressReportTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/ProgressReportTest.java new file mode 100644 index 0000000000..b5ac6fef17 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/ProgressReportTest.java @@ -0,0 +1,102 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge; + +import com.google.common.collect.ImmutableList; +import java.io.File; +import java.util.List; +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.Timeout; +import org.mockito.ArgumentCaptor; +import static org.mockito.Mockito.atLeast; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; +import org.sonar.api.utils.log.Logger; + +public class ProgressReportTest { + + @Rule + public final Timeout timeout = new Timeout(5000); + + @Test(timeout = 5000) + public void test() throws Exception { + Logger logger = mock(Logger.class); + + ProgressReport report = new ProgressReport(ProgressReport.class.getName(), 100, logger, "analyzed"); + + File file = mock(File.class); + when(file.getAbsolutePath()).thenReturn("foo"); + report.start(ImmutableList.of(file, file)); + + // Wait for start message + waitForMessage(logger); + + // Wait for at least one progress message + waitForMessage(logger); + + report.stop(); + + // Waits for the thread to die + // Note: We cannot simply wait for a message here, because it could either be a progress or a stop one + report.join(); + + ArgumentCaptor captor = ArgumentCaptor.forClass(String.class); + verify(logger, atLeast(3)).info(captor.capture()); + + List messages = captor.getAllValues(); + assertThat(messages.size()).isGreaterThanOrEqualTo(3); + assertThat(messages.get(0)).isEqualTo("2 source files to be analyzed"); + for (int i = 1; i < messages.size() - 1; i++) { + assertThat(messages.get(i)).isEqualTo("0/2 files analyzed, current file: foo"); + } + assertThat(messages.get(messages.size() - 1)).isEqualTo("2/2" + " source files have been analyzed"); + } + + @Test(timeout = 5000) + public void testCancel() throws InterruptedException { + Logger logger = mock(Logger.class); + + ProgressReport report = new ProgressReport(ProgressReport.class.getName(), 100, logger, "analyzed"); + File file = mock(File.class); + when(file.getAbsolutePath()).thenReturn("foo"); + report.start(ImmutableList.of(file, file)); + + // Wait for start message + waitForMessage(logger); + + report.cancel(); + report.join(); + + } + + private static void waitForMessage(Logger logger) throws InterruptedException { + synchronized (logger) { + logger.wait(); + } + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedProfileBuilderTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedProfileBuilderTest.java new file mode 100644 index 0000000000..145ce31b6b --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedProfileBuilderTest.java @@ -0,0 +1,116 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +import com.google.common.collect.ImmutableList; +import java.util.Collection; +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Before; +import org.junit.Test; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; +import org.sonar.api.profiles.RulesProfile; +import org.sonar.api.rule.Severity; +import org.sonar.api.rules.ActiveRule; +import org.sonar.api.rules.RuleFinder; +import org.sonar.api.rules.RulePriority; +import org.sonar.api.utils.ValidationMessages; +import org.sonar.check.Rule; + +public class AnnotationBasedProfileBuilderTest { + + private static final String KEY1 = "key1"; + private static final String REPO_KEY = "repo1"; + private static final String PROFILE_NAME = "prfile1"; + private static final String LANGUAGE = "language1"; + + private RuleFinder ruleFinder = mock(RuleFinder.class); + private ValidationMessages messages = ValidationMessages.create(); + org.sonar.api.rules.Rule rule = mock(org.sonar.api.rules.Rule.class); + private AnnotationBasedProfileBuilder builder = new AnnotationBasedProfileBuilder(ruleFinder); + + @Before + public void setupRuleFinder() { + when(rule.getSeverity()).thenReturn(RulePriority.MINOR); + when(rule.isEnabled()).thenReturn(true); + when(ruleFinder.findByKey(REPO_KEY, KEY1)).thenReturn(rule); + } + + @Test + public void should_add_a_rule_with_the_annotation() throws Exception { + @ActivatedByDefault + @Rule(key = KEY1) + class RuleActivatedByDefault { + } + + RulesProfile profile = build(RuleActivatedByDefault.class); + assertThat(profile.getActiveRules()).hasSize(1); + ActiveRule activeRule = profile.getActiveRules().get(0); + assertThat(activeRule.getRule()).isEqualTo(rule); + assertThat(activeRule.getSeverity().toString()).isEqualTo(Severity.MINOR); + assertThat(messages.getWarnings()).isEmpty(); + } + + @Test + public void should_not_add_a_rule_without_the_annotation() throws Exception { + @Rule(key = KEY1) + class RuleNotActivatedByDefault { + } + + RulesProfile profile = build(RuleNotActivatedByDefault.class); + assertThat(profile.getActiveRules()).isEmpty(); + assertThat(messages.getWarnings()).isEmpty(); + } + + @Test + public void unknown_rule_key() throws Exception { + @ActivatedByDefault + @Rule(key = "unknownKey") + class RuleActivatedByDefaultWithUnknownKey { + } + + RulesProfile profile = build(RuleActivatedByDefaultWithUnknownKey.class); + assertThat(profile.getActiveRules()).isEmpty(); + assertThat(messages.getWarnings()).hasSize(1); + assertThat(messages.getWarnings().get(0)).matches(".*not found.*unknownKey.*"); + } + + @Test + public void should_ignore_class_without_rule_annotation() throws Exception { + @ActivatedByDefault + class ClassWithoutRuleAnnotation { + } + + RulesProfile profile = build(ClassWithoutRuleAnnotation.class); + assertThat(profile.getActiveRules()).isEmpty(); + assertThat(messages.getWarnings()).hasSize(1); + assertThat(messages.getWarnings().get(0)).matches(".*ClassWithoutRuleAnnotation.*no Rule annotation.*"); + } + + private RulesProfile build(Class clazz) { + Collection annotatedClasses = ImmutableList.of(clazz); + return builder.build(REPO_KEY, PROFILE_NAME, LANGUAGE, annotatedClasses, messages); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedRulesDefinitionTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedRulesDefinitionTest.java new file mode 100644 index 0000000000..b3e45dbe93 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/annotations/AnnotationBasedRulesDefinitionTest.java @@ -0,0 +1,331 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.annotations; + +import com.google.common.collect.ImmutableList; +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.sonar.api.server.debt.DebtRemediationFunction; +import org.sonar.api.server.debt.DebtRemediationFunction.Type; +import org.sonar.api.server.rule.*; +import org.sonar.api.server.rule.RulesDefinition.NewRepository; +import org.sonar.api.server.rule.RulesDefinition.Param; +import org.sonar.api.server.rule.RulesDefinition.Repository; +import org.sonar.api.server.rule.RulesDefinition.SubCharacteristics; +import org.sonar.check.Cardinality; +import org.sonar.check.Rule; +import org.sonar.check.RuleProperty; + +public class AnnotationBasedRulesDefinitionTest { + + private static final String REPO_KEY = "repoKey"; + private static final String LANGUAGE_KEY_WITH_RESOURCE_BUNDLE = "languageKey"; + + private RulesDefinition.Context context = new RulesDefinition.Context(); + + @org.junit.Rule + public ExpectedException thrown = ExpectedException.none(); + + @Test + public void no_class_to_add() throws Exception { + assertThat(buildRepository(false).rules()).isEmpty(); + } + + @Test + public void class_without_rule_annotation() throws Exception { + class NotRuleClass { + } + thrown.expect(IllegalArgumentException.class); + buildSingleRuleRepository(NotRuleClass.class); + } + + @Test + public void rule_annotation_data() throws Exception { + + @Rule(key = "key1", name = "name1", description = "description1", tags = "mytag") + class RuleClass { + + @RuleProperty(key = "param1Key", description = "param1 description") + public String param1 = "x"; + } + + RulesDefinition.Rule rule = buildSingleRuleRepository(RuleClass.class); + assertThat(rule.key()).isEqualTo("key1"); + assertThat(rule.name()).isEqualTo("name1"); + assertThat(rule.htmlDescription()).isEqualTo("description1"); + assertThat(rule.markdownDescription()).isNull(); + assertThat(rule.tags()).containsOnly("mytag"); + assertThat(rule.template()).isFalse(); + assertThat(rule.params()).hasSize(1); + assertParam(rule.params().get(0), "param1Key", "param1 description"); + } + + @Rule(name = "name1", description = "description1") + class RuleClassWithoutAnnotationDefinedKey { + } + + @Test + public void rule_without_explicit_key() throws Exception { + thrown.expect(IllegalArgumentException.class); + buildSingleRuleRepository(RuleClassWithoutAnnotationDefinedKey.class); + } + + @Test + public void rule_without_explicit_key_can_be_acceptable() throws Exception { + Repository repository = buildRepository(LANGUAGE_KEY_WITH_RESOURCE_BUNDLE, false, false, + RuleClassWithoutAnnotationDefinedKey.class); + RulesDefinition.Rule rule = repository.rules().get(0); + assertThat(rule.key()).isEqualTo(RuleClassWithoutAnnotationDefinedKey.class.getCanonicalName()); + assertThat(rule.name()).isEqualTo("name1"); + } + + @Test + public void external_names_and_descriptions() throws Exception { + + @Rule(key = "ruleWithExternalInfo") + class RuleClass { + + @RuleProperty(key = "param1Key") + public String param1 = "x"; + @RuleProperty + public String param2 = "x"; + } + + RulesDefinition.Rule rule = buildSingleRuleRepository(RuleClass.class); + assertThat(rule.key()).isEqualTo("ruleWithExternalInfo"); + assertThat(rule.name()).isEqualTo("external name for ruleWithExternalInfo"); + assertThat(rule.htmlDescription()).isEqualTo("description for ruleWithExternalInfo"); + assertThat(rule.params()).hasSize(2); + assertParam(rule.params().get(0), "param1Key", "description for param1"); + assertParam(rule.params().get(1), "param2", null); + } + + @Test + public void no_name_and_no_resource_bundle() throws Exception { + @Rule(key = "ruleWithExternalInfo") + class RuleClass { + } + + thrown.expect(IllegalStateException.class); + buildRepository("languageWithoutBundle", false, false, RuleClass.class); + } + + @Test + public void rule_template() throws Exception { + @Rule(key = "key1", name = "name1", description = "description1") + @NoSqale + @RuleTemplate + class RuleClass { + } + + RulesDefinition.Rule rule = buildSingleRuleRepository(RuleClass.class); + assertThat(rule.template()).isTrue(); + } + + @Test + public void cardinality_single() throws Exception { + @Rule(key = "key1", name = "name1", description = "description1", cardinality = Cardinality.SINGLE) + class RuleClass { + } + + RulesDefinition.Rule rule = buildSingleRuleRepository(RuleClass.class); + assertThat(rule.template()).isFalse(); + } + + @Test + public void cardinality_multiple() throws Exception { + @Rule(key = "key1", name = "name1", description = "description1", cardinality = Cardinality.MULTIPLE) + class RuleClass { + } + + thrown.expect(IllegalArgumentException.class); + buildSingleRuleRepository(RuleClass.class); + } + + @Test + public void class_without_sqale_annotation() throws Exception { + @Rule(key = "key1", name = "name1", description = "description1") + class RuleClass { + } + + thrown.expect(IllegalArgumentException.class); + buildRepository(true, RuleClass.class); + } + + @Test + public void class_with_nosqale_annotation() throws Exception { + + @Rule(key = "key1", name = "name1", description = "description1") + @NoSqale + class RuleClass { + } + + Repository repository = buildRepository(true, RuleClass.class); + assertThat(repository.rules()).hasSize(1); + } + + @Test + public void class_with_sqale_constant_remediation() throws Exception { + + @Rule(key = "key1", name = "name1", description = "description1") + @SqaleSubCharacteristic(SubCharacteristics.CPU_EFFICIENCY) + @SqaleConstantRemediation("10min") + class RuleClass { + } + + RulesDefinition.Rule rule = buildSingleRuleRepository(RuleClass.class); + assertRemediation(rule, Type.CONSTANT_ISSUE, null, "10min", null); + } + + @Test + public void class_with_sqale_linear_remediation() throws Exception { + + @Rule(key = "key1", name = "name1", description = "description1") + @SqaleSubCharacteristic(SubCharacteristics.CPU_EFFICIENCY) + @SqaleLinearRemediation(coeff = "2h", effortToFixDescription = "Effort to test one uncovered condition") + class RuleClass { + } + + RulesDefinition.Rule rule = buildSingleRuleRepository(RuleClass.class); + assertRemediation(rule, Type.LINEAR, "2h", null, "Effort to test one uncovered condition"); + } + + @Test + public void class_with_sqale_linear_with_offset_remediation() throws Exception { + + @Rule(key = "key1", name = "name1", description = "description1") + @SqaleSubCharacteristic(SubCharacteristics.CPU_EFFICIENCY) + @SqaleLinearWithOffsetRemediation(coeff = "5min", offset = "1h", + effortToFixDescription = "Effort to test one uncovered condition") + class RuleClass { + } + + RulesDefinition.Rule rule = buildSingleRuleRepository(RuleClass.class); + assertRemediation(rule, Type.LINEAR_OFFSET, "5min", "1h", "Effort to test one uncovered condition"); + } + + @Test + public void class_with_several_sqale_remediation_annotations() throws Exception { + @Rule(key = "key1", name = "name1", description = "description1") + @SqaleSubCharacteristic(SubCharacteristics.CPU_EFFICIENCY) + @SqaleConstantRemediation("10min") + @SqaleLinearRemediation(coeff = "2h", effortToFixDescription = "Effort to test one uncovered condition") + class RuleClass { + } + + thrown.expect(IllegalArgumentException.class); + buildSingleRuleRepository(RuleClass.class); + } + + @Test + public void invalid_sqale_annotation() throws Exception { + @Rule(key = "key1", name = "name1", description = "description1") + @SqaleSubCharacteristic(SubCharacteristics.CPU_EFFICIENCY) + @SqaleConstantRemediation("xxx") + class MyInvalidRuleClass { + } + + thrown.expect(IllegalArgumentException.class); + thrown.expectMessage("MyInvalidRuleClass"); + buildSingleRuleRepository(MyInvalidRuleClass.class); + } + + @Test + public void rule_not_created_by_RulesDefinitionAnnotationLoader() throws Exception { + @Rule + class RuleClass { + } + NewRepository newRepository = context.createRepository(REPO_KEY, "language1"); + AnnotationBasedRulesDefinition rulesDef = new AnnotationBasedRulesDefinition(newRepository, "language1"); + thrown.expect(IllegalStateException.class); + rulesDef.newRule(RuleClass.class, false); + } + + @Test + public void load_method_with_class_without_sqale_annotation() throws Exception { + @Rule(key = "key1", name = "name1", description = "description1") + class RuleClass { + } + thrown.expect(IllegalArgumentException.class); + load(RuleClass.class); + } + + @Test + public void load_method_with_class_with_sqale_annotations() throws Exception { + @Rule(key = "key1", name = "name1", description = "description1") + @SqaleSubCharacteristic(SubCharacteristics.CPU_EFFICIENCY) + @SqaleConstantRemediation("10min") + class RuleClass { + } + Repository repository = load(RuleClass.class); + assertThat(repository.rules()).hasSize(1); + } + + private void assertRemediation(RulesDefinition.Rule rule, Type type, String coeff, String offset, String effortDesc) { + DebtRemediationFunction remediationFunction = rule.debtRemediationFunction(); + assertThat(remediationFunction.type()).isEqualTo(type); + assertThat(remediationFunction.coefficient()).isEqualTo(coeff); + assertThat(remediationFunction.offset()).isEqualTo(offset); + assertThat(rule.effortToFixDescription()).isEqualTo(effortDesc); + } + + private void assertParam(Param param, String expectedKey, String expectedDescription) { + assertThat(param.key()).isEqualTo(expectedKey); + assertThat(param.name()).isEqualTo(expectedKey); + assertThat(param.description()).isEqualTo(expectedDescription); + } + + private RulesDefinition.Rule buildSingleRuleRepository(Class ruleClass) { + Repository repository = buildRepository(false, ruleClass); + assertThat(repository.rules()).hasSize(1); + return repository.rules().get(0); + } + + private Repository buildRepository(boolean failIfSqaleNotFound, Class... classes) { + return buildRepository(LANGUAGE_KEY_WITH_RESOURCE_BUNDLE, failIfSqaleNotFound, true, classes); + } + + private Repository buildRepository(String languageKey, boolean failIfSqaleNotFound, boolean failIfNoExplicitKey, + Class... classes) { + NewRepository newRepository = createRepository(languageKey); + new AnnotationBasedRulesDefinition(newRepository, languageKey) + .addRuleClasses(failIfSqaleNotFound, failIfNoExplicitKey, ImmutableList.copyOf(classes)); + newRepository.done(); + return context.repository(REPO_KEY); + } + + private Repository load(Class... classes) { + String languageKey = LANGUAGE_KEY_WITH_RESOURCE_BUNDLE; + NewRepository newRepository = createRepository(languageKey); + AnnotationBasedRulesDefinition.load(newRepository, languageKey, ImmutableList.copyOf(classes)); + newRepository.done(); + return context.repository(REPO_KEY); + } + + private NewRepository createRepository(String languageKey) { + return context.createRepository(REPO_KEY, languageKey); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/CheckMessageTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/CheckMessageTest.java new file mode 100644 index 0000000000..a42bf0f3cd --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/CheckMessageTest.java @@ -0,0 +1,45 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import static org.hamcrest.Matchers.is; +import static org.junit.Assert.assertThat; +import org.junit.Test; + +public class CheckMessageTest { + + @Test + public void testFormatDefaultMessage() { + CheckMessage message = new CheckMessage(null, "Value is {0,number,integer}, expected value is {1,number,integer}.", + 3, 7); + assertThat(message.formatDefaultMessage(), is("Value is 3, expected value is 7.")); + } + + @Test + public void testNotFormatMessageWithoutParameters() { + CheckMessage message = new CheckMessage(null, "public void main(){."); // This message can't be used as a pattern by the MessageFormat + // class + assertThat(message.formatDefaultMessage(), is("public void main(){.")); + } +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceCodeTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceCodeTest.java new file mode 100644 index 0000000000..3efce2725f --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceCodeTest.java @@ -0,0 +1,157 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import static org.fest.assertions.Assertions.assertThat; +import static org.hamcrest.CoreMatchers.is; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThat; +import static org.junit.Assert.assertTrue; +import org.junit.Before; +import org.junit.Test; +import org.sonar.cxx.squidbridge.measures.Measurable; +import org.sonar.cxx.squidbridge.measures.Metric; + +public class SourceCodeTest { + + private SourceProject prj; + private SourcePackage pac; + private SourcePackage pac2; + private SourceCode cla; + private SourceCode cla2; + + @Before + public void before() { + prj = new SourceProject("dummy project"); + pac = new SourcePackage("org.sonar"); + pac2 = new SourcePackage("org.sonar2"); + pac2 = new SourcePackage("org.sonar2"); + cla = new SourceClass("org.sonar.Toto", "Toto"); + cla2 = new SourceClass("org.sonar2.Tata", "Tata"); + prj.addChild(pac); + prj.addChild(pac2); + pac.addChild(cla); + pac.addChild(cla2); + } + + @Test + public void testAddChild() { + prj.addChild(pac); + assertEquals(pac.getParent(), prj); + assertTrue(prj.getChildren().contains(pac)); + } + + @Test + public void testEqualsAndHashCode() { + assertThat(prj).isNotEqualTo(pac); + assertThat(prj.hashCode()).isNotEqualTo(pac.hashCode()); + assertThat(prj).isNotEqualTo(new Object()); + + SourceCode samePac = new SourcePackage("org.sonar"); + assertThat(pac).isEqualTo(samePac); + assertThat(pac.hashCode()).isEqualTo(samePac.hashCode()); + } + + @Test + public void testContains() { + assertThat(prj.hasChild(pac), is(true)); + assertThat(prj.hasChild(cla), is(true)); + } + + @Test + public void testIsType() { + SourcePackage pacFrom = new SourcePackage("org.from"); + assertFalse(pacFrom.isType(SourceCode.class)); + assertFalse(pacFrom.isType(SourceClass.class)); + assertTrue(pacFrom.isType(SourcePackage.class)); + } + + @Test + public void testGetParentByType() { + SourcePackage pacFrom = new SourcePackage("org.from"); + SourceFile fileFrom = new SourceFile("org.from.From.java", "From.java"); + SourceClass classFrom = new SourceClass("org.from.From", "From"); + pacFrom.addChild(fileFrom); + fileFrom.addChild(classFrom); + assertEquals(pacFrom, classFrom.getParent(SourcePackage.class)); + } + + @Test + public void testGetAncestorByType() { + SourceFile file = new SourceFile("org.from.From.java", "From.java"); + SourceClass class1 = new SourceClass("org.from.From", "From"); + SourceClass class2 = new SourceClass("org.from.From$Foo", "From$Foo"); + SourceMethod method = new SourceMethod(class2, "foo()", 10); + file.addChild(class1); + class1.addChild(class2); + class2.addChild(method); + + assertEquals(file, class1.getAncestor(SourceFile.class)); + assertEquals(class1, class2.getAncestor(SourceClass.class)); + assertEquals(file, class2.getAncestor(SourceFile.class)); + assertEquals(class1, method.getAncestor(SourceClass.class)); + assertEquals(file, method.getAncestor(SourceFile.class)); + } + + @Test + public void testHasAmongParents() { + assertTrue(cla.hasAmongParents(prj)); + assertTrue(cla.hasAmongParents(pac)); + assertFalse(prj.hasAmongParents(cla)); + } + + @Test(expected = IllegalStateException.class) + public void setMeasureOnCalculatedMetric() { + Measurable measurable = new SourceFile("org.Toto.java"); + measurable.setMeasure(Metric.INSTABILITY, 0); + } + + @Test + public void testConmputeMeasures() { + cla2.setMeasure(Metric.COMPLEXITY, 4); + cla.setMeasure(Metric.COMPLEXITY, 2); + cla.setMeasure(Metric.CA, 2); + SourceCodeTreeDecorator decorator = new SourceCodeTreeDecorator(prj); + decorator.decorateWith(Metric.values()); + assertEquals(6, prj.getInt(Metric.COMPLEXITY)); + assertEquals(0, prj.getInt(Metric.CA)); + } + + @Test + public void testAddData() { + SourceCode myFile = new SourceFile("org.sonar2.Tata.java"); + myFile.addData(Metric.LCOM4_BLOCKS, "blocks detail"); + assertEquals("blocks detail", myFile.getData(Metric.LCOM4_BLOCKS)); + } + + @Test + public void getCheckMessages() { + SourceCode foo = new SourceFile("Foo.java"); + assertThat(foo.getCheckMessages().size(), is(0)); + + foo.log(new CheckMessage(null, "message")); + assertThat(foo.getCheckMessages().size(), is(1)); + } +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceCodeTreeDecoratorTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceCodeTreeDecoratorTest.java new file mode 100644 index 0000000000..d63bd04bd0 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceCodeTreeDecoratorTest.java @@ -0,0 +1,123 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import static org.junit.Assert.assertEquals; +import org.junit.Test; +import org.sonar.cxx.squidbridge.measures.Metric; + +public class SourceCodeTreeDecoratorTest { + + private int idCounter = 0; + + @Test + public void addMethodMeasures() { + SourceCode method1 = new SourceMethod("method1"); + method1.setMeasure(Metric.COMPLEXITY, 4); + method1.setMeasure(Metric.STATEMENTS, 8); + method1.setMeasure(Metric.METHODS, 1); + SourceCode method2 = new SourceMethod("method2"); + method2.setMeasure(Metric.COMPLEXITY, 2); + method2.setMeasure(Metric.STATEMENTS, 3); + method2.setMeasure(Metric.METHODS, 1); + SourceCode method3 = new SourceMethod("method3"); + method3.setMeasure(Metric.COMPLEXITY, 1); + method3.setMeasure(Metric.STATEMENTS, 3); + method3.setMeasure(Metric.METHODS, 1); + SourceCode class1 = new SourceClass("class1"); + class1.addChild(method1); + class1.addChild(method2); + class1.addChild(method3); + + SourceProject project = new SourceProject("project"); + project.addChild(class1); + decorate(project); + + assertEquals(3, class1.getInt(Metric.METHODS)); + assertEquals(7, class1.getInt(Metric.COMPLEXITY)); + } + + private SourceCode createTestMethod(SourceCode classResource) { + SourceCode method = new SourceMethod("test" + idCounter++); + classResource.addChild(method); + return method; + } + + private SourceCode createTestClass() { + return new SourceClass("class" + idCounter++); + } + + private SourceCode createTestComplexityMethod(SourceCode classResource, int complexity) { + SourceCode method = createTestMethod(classResource); + method.setMeasure(Metric.COMPLEXITY, complexity); + return method; + } + + @Test + public void classMethodComplexityDistribution() { + SourceCode testClass = createTestClass(); + createTestComplexityMethod(testClass, 4); + createTestComplexityMethod(testClass, 2); + createTestComplexityMethod(testClass, 3); + SourceProject project = new SourceProject("project"); + project.addChild(testClass); + decorate(project); + } + + @Test + public void addPackageMeasures() { + SourceCode package1 = new SourcePackage("pack1"); + package1.setMeasure(Metric.CLASSES, 12); + package1.setMeasure(Metric.METHODS, 87); + package1.setMeasure(Metric.COMPLEXITY, 834); + package1.setMeasure(Metric.LINES, 1450); + package1.setMeasure(Metric.PACKAGES, 1); + SourceCode package2 = new SourcePackage("pack2"); + package2.setMeasure(Metric.CLASSES, 9); + package2.setMeasure(Metric.METHODS, 73); + package2.setMeasure(Metric.COMPLEXITY, 287); + package2.setMeasure(Metric.LINES, 893); + package2.setMeasure(Metric.PACKAGES, 1); + SourceCode package3 = new SourcePackage("pack3"); + package3.setMeasure(Metric.CLASSES, 9); + package3.setMeasure(Metric.METHODS, 73); + package3.setMeasure(Metric.COMPLEXITY, 287); + package3.setMeasure(Metric.LINES, 938); + package3.setMeasure(Metric.PACKAGES, 1); + SourceProject prj1 = new SourceProject("prj1"); + prj1.addChild(package1); + prj1.addChild(package2); + prj1.addChild(package3); + decorate(prj1); + assertEquals(3, prj1.getInt(Metric.PACKAGES)); + assertEquals(30, prj1.getInt(Metric.CLASSES)); + assertEquals(233, prj1.getInt(Metric.METHODS)); + assertEquals(3281, prj1.getInt(Metric.LINES)); + } + + private void decorate(SourceProject project) { + SourceCodeTreeDecorator decorator = new SourceCodeTreeDecorator(project); + decorator.decorateWith(Metric.values()); + } +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceFileTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceFileTest.java new file mode 100644 index 0000000000..73abada2e9 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceFileTest.java @@ -0,0 +1,54 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import java.util.HashSet; +import java.util.Set; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; +import org.junit.Test; + +public class SourceFileTest { + + @Test + public void testGetStartAtLine() { + SourceFile file = new SourceFile("com/sonarsource/Toto.java"); + assertEquals(1, file.getStartAtLine()); + file = new SourceFile("com/sonarsource/Toto.java", "Toto.java"); + assertEquals(1, file.getStartAtLine()); + } + + @Test + public void testHasNoSon() { + SourceFile file = new SourceFile("com/sonarsource/Toto.java"); + Set noSonarTagLines = new HashSet(); + noSonarTagLines.add(23); + noSonarTagLines.add(10); + file.addNoSonarTagLines(noSonarTagLines); + assertTrue(file.hasNoSonarTagAtLine(23)); + assertTrue(file.hasNoSonarTagAtLine(10)); + assertFalse(file.hasNoSonarTagAtLine(11)); + } +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceMethodTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceMethodTest.java new file mode 100644 index 0000000000..e9f5f93749 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/api/SourceMethodTest.java @@ -0,0 +1,37 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.api; + +import static org.junit.Assert.assertEquals; +import org.junit.Test; + +public class SourceMethodTest { + + @Test + public void testSquidMethodSquidClassString() { + SourceMethod squidMethod = new SourceMethod(new SourceClass("org.sonar.Squid"), "scan:23", 23); + assertEquals("org.sonar.Squid#scan:23", squidMethod.getKey()); + assertEquals(23, squidMethod.getStartAtLine()); + } +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractCommentRegularExpressionCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractCommentRegularExpressionCheckTest.java new file mode 100644 index 0000000000..16d320f90c --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractCommentRegularExpressionCheckTest.java @@ -0,0 +1,96 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.Grammar; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.sonar.api.utils.SonarException; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractCommentRegularExpressionCheckTest { + + @Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + @Rule + public ExpectedException thrown = ExpectedException.none(); + + private static class Check extends AbstractCommentRegularExpressionCheck { + + private String regularExpression; + private String message; + + @Override + public String getRegularExpression() { + return regularExpression; + } + + @Override + public String getMessage() { + return message; + } + } + + private Check check = new Check(); + + @Test + public void empty() { + check.regularExpression = ""; + check.message = "Empty regular expression."; + + checkMessagesVerifier.verify(scanFile("/checks/commentRegularExpression.mc", check).getCheckMessages()); + } + + @Test + public void case_insensitive() { + check.regularExpression = "(?i).*TODO.*"; + check.message = "Avoid TODO."; + + checkMessagesVerifier.verify(scanFile("/checks/commentRegularExpression.mc", check).getCheckMessages()) + .next().atLine(3).withMessage("Avoid TODO.") + .next().atLine(5) + .next().atLine(7); + } + + @Test + public void case_sensitive() { + check.regularExpression = ".*TODO.*"; + check.message = "Avoid TODO."; + + checkMessagesVerifier.verify(scanFile("/checks/commentRegularExpression.mc", check).getCheckMessages()) + .next().atLine(3).withMessage("Avoid TODO."); + } + + @Test + public void wrong_regular_expression() { + check.regularExpression = "*"; + + thrown.expect(SonarException.class); + thrown.expectMessage("Unable to compile regular expression: *"); + scanFile("/checks/commentRegularExpression.mc", check); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractFileComplexityCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractFileComplexityCheckTest.java new file mode 100644 index 0000000000..ba3fd1fd12 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractFileComplexityCheckTest.java @@ -0,0 +1,85 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.Grammar; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.sonar.api.utils.SonarException; +import org.sonar.cxx.squidbridge.measures.MetricDef; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; +import org.sonar.cxx.squidbridge.test.miniC.MiniCAstScanner.MiniCMetrics; + +public class AbstractFileComplexityCheckTest { + + @Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + @Rule + public ExpectedException thrown = ExpectedException.none(); + + private static class Check extends AbstractFileComplexityCheck { + + public int maximumFileComplexity = 100; + + @Override + public int getMaximumFileComplexity() { + return maximumFileComplexity; + } + + @Override + public MetricDef getComplexityMetric() { + return MiniCMetrics.COMPLEXITY; + } + + } + + private Check check = new Check(); + + @Test + public void fileComplexityEqualsMaximum() { + check.maximumFileComplexity = 5; + + checkMessagesVerifier.verify(scanFile("/checks/complexity5.mc", check).getCheckMessages()); + } + + @Test + public void fileComplexityGreaterMaximum() { + check.maximumFileComplexity = 4; + + checkMessagesVerifier.verify(scanFile("/checks/complexity5.mc", check).getCheckMessages()) + .next().withMessage("The file is too complex (5 while maximum allowed is set to 4)."); + } + + @Test + public void wrong_parameter() { + check.maximumFileComplexity = 0; + + thrown.expect(SonarException.class); + thrown.expectMessage("The complexity threshold must be set to a value greater than 0, but given: 0"); + scanFile("/checks/complexity5.mc", check); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractGotoCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractGotoCheckTest.java new file mode 100644 index 0000000000..9af42aca44 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractGotoCheckTest.java @@ -0,0 +1,52 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.test.minic.MiniCGrammar; +import org.junit.Test; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractGotoCheckTest { + + @org.junit.Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + private static class Check extends AbstractGotoCheck { + + @Override + public AstNodeType getGotoRule() { + return MiniCGrammar.BREAK_STATEMENT; + } + + } + + @Test + public void detected() { + checkMessagesVerifier.verify(scanFile("/checks/goto.mc", new Check()).getCheckMessages()) + .next().atLine(9).withMessage("Goto should be avoided."); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractLineLengthCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractLineLengthCheckTest.java new file mode 100644 index 0000000000..d1579fbb5e --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractLineLengthCheckTest.java @@ -0,0 +1,78 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.Grammar; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.sonar.api.utils.SonarException; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractLineLengthCheckTest { + + @Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + @Rule + public ExpectedException thrown = ExpectedException.none(); + + private static class Check extends AbstractLineLengthCheck { + + public int maximumLineLength = 80; + + @Override + public int getMaximumLineLength() { + return maximumLineLength; + } + + } + + private Check check = new Check(); + + @Test + public void lineLengthWithDefaultLength() { + checkMessagesVerifier.verify(scanFile("/checks/line_length.mc", check).getCheckMessages()) + .next().atLine(3).withMessage("The line length is greater than 80 authorized."); + } + + @Test + public void lineLengthWithSpecificLength() { + check.maximumLineLength = 7; + + checkMessagesVerifier.verify(scanFile("/checks/line_length.mc", check).getCheckMessages()) + .next().atLine(3) + .next().atLine(4); + } + + @Test + public void wrong_parameter() { + check.maximumLineLength = 0; + + thrown.expect(SonarException.class); + thrown.expectMessage("The maximal line length must be set to a value greater than 0, but given: 0"); + scanFile("/checks/line_length.mc", check); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractMagicCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractMagicCheckTest.java new file mode 100644 index 0000000000..fb52121683 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractMagicCheckTest.java @@ -0,0 +1,78 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.google.common.collect.ImmutableSet; +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.test.minic.MiniCGrammar; +import com.sonar.sslr.test.minic.MiniCLexer; +import java.util.Set; +import org.junit.Rule; +import org.junit.Test; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractMagicCheckTest { + + @Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + private static class Check extends AbstractMagicCheck { + + @Override + public Set getPatterns() { + return ImmutableSet.of(MiniCLexer.Literals.INTEGER); + } + + @Override + public Set getInclusions() { + return ImmutableSet.of(MiniCGrammar.WHILE_STATEMENT); + } + + @Override + public Set getExclusions() { + return ImmutableSet.of(MiniCGrammar.VARIABLE_INITIALIZER); + } + + @Override + public boolean isExcepted(AstNode candidate) { + return "1337".equals(candidate.getTokenOriginalValue()); + } + + @Override + public String getMessage() { + return "Avoid magic stuff."; + } + + } + + @Test + public void detected() { + checkMessagesVerifier.verify(scanFile("/checks/magic.mc", new Check()).getCheckMessages()) + .next().atLine(5).withMessage("Avoid magic stuff.") + .next().atLine(9); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNamingCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNamingCheckTest.java new file mode 100644 index 0000000000..b6f6581756 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNamingCheckTest.java @@ -0,0 +1,97 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.test.minic.MiniCGrammar; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.sonar.api.utils.SonarException; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractNamingCheckTest { + + @org.junit.Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + @Rule + public ExpectedException thrown = ExpectedException.none(); + + private static class Check extends AbstractNamingCheck { + + private String regularExpression; + + @Override + public AstNodeType[] getRules() { + return new AstNodeType[]{ + MiniCGrammar.BIN_FUNCTION_DEFINITION, + MiniCGrammar.BIN_VARIABLE_DEFINITION + }; + } + + @Override + public String getName(AstNode astNode) { + return astNode.getTokenValue(); + } + + @Override + public String getRegexp() { + return regularExpression; + } + + @Override + public String getMessage(String name) { + return "\"" + name + "\" is a bad name."; + } + + @Override + public boolean isExcluded(AstNode astNode) { + return "LINE".equals(astNode.getTokenValue()); + } + + } + + private final Check check = new Check(); + + @Test + public void detected() { + check.regularExpression = "[a-z]+"; + checkMessagesVerifier.verify(scanFile("/checks/naming.mc", check).getCheckMessages()) + .next().atLine(5).withMessage("\"BAD\" is a bad name.") + .next().atLine(12).withMessage("\"myFunction\" is a bad name."); + } + + @Test + public void wrong_regular_expression() { + check.regularExpression = "*"; + + thrown.expect(SonarException.class); + thrown.expectMessage("Unable to compile regular expression: *"); + scanFile("/checks/naming.mc", check); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNestedCommentsCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNestedCommentsCheckTest.java new file mode 100644 index 0000000000..1df7be5ea4 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNestedCommentsCheckTest.java @@ -0,0 +1,57 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.google.common.collect.Sets; +import com.sonar.sslr.api.Grammar; +import java.util.Collections; +import java.util.Set; +import org.junit.Rule; +import org.junit.Test; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractNestedCommentsCheckTest { + + @Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + private static class Check extends AbstractNestedCommentsCheck { + + private static final Set COMMENT_START_TAGS = Collections.unmodifiableSet(Sets.newHashSet("/*", "//")); + + @Override + public Set getCommentStartTags() { + return COMMENT_START_TAGS; + } + + } + + @Test + public void singleLineCommentsSyntax() { + checkMessagesVerifier.verify(scanFile("/checks/nested_comments.mc", new Check()).getCheckMessages()) + .next().atLine(1).withMessage("This comments contains the nested comment start tag \"/*\"") + .next().atLine(2).withMessage("This comments contains the nested comment start tag \"//\""); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNestedIfCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNestedIfCheckTest.java new file mode 100644 index 0000000000..7f1af7712d --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNestedIfCheckTest.java @@ -0,0 +1,85 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.test.minic.MiniCGrammar; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.sonar.api.utils.SonarException; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractNestedIfCheckTest { + + @Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + @Rule + public ExpectedException thrown = ExpectedException.none(); + + private static class Check extends AbstractNestedIfCheck { + + public int maximumNestingLevel = 3; + + @Override + public int getMaximumNestingLevel() { + return maximumNestingLevel; + } + + @Override + public AstNodeType getIfRule() { + return MiniCGrammar.IF_STATEMENT; + } + + } + + private final Check check = new Check(); + + @Test + public void nestedIfWithDefaultNesting() { + checkMessagesVerifier.verify(scanFile("/checks/nested_if.mc", check).getCheckMessages()) + .next().atLine(9).withMessage("This if has a nesting level of 4, which is higher than the maximum allowed 3."); + } + + @Test + public void nestedIfWithSpecificNesting() { + check.maximumNestingLevel = 2; + + checkMessagesVerifier.verify(scanFile("/checks/nested_if.mc", check).getCheckMessages()) + .next().atLine(7) + .next().atLine(27); + } + + @Test + public void wrong_parameter() { + check.maximumNestingLevel = 0; + + thrown.expect(SonarException.class); + thrown.expectMessage("The maximal if nesting level must be set to a value greater than 0, but given: 0"); + scanFile("/checks/nested_if.mc", check); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNoSonarCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNoSonarCheckTest.java new file mode 100644 index 0000000000..7f3ae21502 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractNoSonarCheckTest.java @@ -0,0 +1,47 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.Grammar; +import org.junit.Rule; +import org.junit.Test; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractNoSonarCheckTest { + + @Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + private static class Check extends AbstractNoSonarCheck { + } + + @Test + public void singleLineCommentsSyntax() { + checkMessagesVerifier.verify(scanFile("/checks/no_sonar.mc", new Check()).getCheckMessages()) + .next().atLine(5).withMessage("Is NOSONAR usage acceptable or does it hide a real quality flaw?") + .next().atLine(6) + .next().atLine(10); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractOneStatementPerLineCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractOneStatementPerLineCheckTest.java new file mode 100644 index 0000000000..a930b14c26 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractOneStatementPerLineCheckTest.java @@ -0,0 +1,59 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.test.minic.MiniCGrammar; +import org.junit.Test; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractOneStatementPerLineCheckTest { + + @org.junit.Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + private static class Check extends AbstractOneStatementPerLineCheck { + + @Override + public AstNodeType getStatementRule() { + return MiniCGrammar.STATEMENT; + } + + @Override + public boolean isExcluded(AstNode statementNode) { + return statementNode.getChild(0).is(MiniCGrammar.COMPOUND_STATEMENT); + } + + } + + @Test + public void detected() { + checkMessagesVerifier.verify(scanFile("/checks/one_statement_per_line.mc", new Check()).getCheckMessages()) + .next().atLine(7).withMessage( + "At most one statement is allowed per line, but 2 statements were found on this line."); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractParseErrorCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractParseErrorCheckTest.java new file mode 100644 index 0000000000..4197b2e130 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractParseErrorCheckTest.java @@ -0,0 +1,47 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.Grammar; +import org.junit.Rule; +import org.junit.Test; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractParseErrorCheckTest { + + @Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + private static class Check extends AbstractParseErrorCheck { + } + + private Check check = new Check(); + + @Test + public void parseError() { + checkMessagesVerifier.verify(scanFile("/checks/parse_error.mc", check).getCheckMessages()) + .next().atLine(3); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractSingleLineCommentsSyntaxCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractSingleLineCommentsSyntaxCheckTest.java new file mode 100644 index 0000000000..4782e3ed12 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractSingleLineCommentsSyntaxCheckTest.java @@ -0,0 +1,52 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.Grammar; +import org.junit.Rule; +import org.junit.Test; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractSingleLineCommentsSyntaxCheckTest { + + @Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + private static class Check extends AbstractSingleLineCommentsSyntaxCheck { + + @Override + public String getSingleLineCommentSyntaxPrefix() { + return "//"; + } + + } + + @Test + public void singleLineCommentsSyntax() { + checkMessagesVerifier.verify(scanFile("/checks/single_line_comments_syntax.mc", new Check()).getCheckMessages()) + .next().atLine(1).withMessage("This single line comment should use the single line comment syntax \"//\"") + .next().atLine(15); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractXPathCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractXPathCheckTest.java new file mode 100644 index 0000000000..6cef44f7cb --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/AbstractXPathCheckTest.java @@ -0,0 +1,111 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.Grammar; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.sonar.api.utils.SonarException; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class AbstractXPathCheckTest { + + @Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + @Rule + public ExpectedException thrown = ExpectedException.none(); + + private static class Check extends AbstractXPathCheck { + + private String xpath; + private String message; + + @Override + public String getXPathQuery() { + return xpath; + } + + @Override + public String getMessage() { + return message; + } + + } + + private Check check = new Check(); + + @Test + public void emptyXPathCheck() { + check.xpath = ""; + check.message = "Empty XPath check."; + + checkMessagesVerifier.verify(scanFile("/checks/xpath.mc", check).getCheckMessages()); + } + + @Test + public void booleanXPathCheckWithResults() { + check.xpath = "count(//VARIABLE_DEFINITION) > 0"; + check.message = "Boolean XPath rule with results."; + + checkMessagesVerifier.verify(scanFile("/checks/xpath.mc", check).getCheckMessages()) + .next().withMessage("Boolean XPath rule with results."); + } + + @Test + public void booleanXPathCheckWithoutResults() { + check.xpath = "count(//variableDefinition) > 2"; + check.message = "Boolean XPath rule without results."; + + checkMessagesVerifier.verify(scanFile("/checks/xpath.mc", check).getCheckMessages()); + } + + @Test + public void astNodesXpathCheck() { + check.xpath = "//VARIABLE_DEFINITION"; + check.message = "No variable definitions allowed!"; + + checkMessagesVerifier.verify(scanFile("/checks/xpath.mc", check).getCheckMessages()) + .next().atLine(1).withMessage("No variable definitions allowed!") + .next().atLine(5); + } + + @Test + public void parse_error() { + check.xpath = "//VARIABLE_DEFINITION"; + + checkMessagesVerifier.verify(scanFile("/checks/parse_error.mc", check).getCheckMessages()); + } + + @Test + public void wrong_xpath() { + check.xpath = "//"; + + thrown.expect(SonarException.class); + thrown.expectMessage("Unable to initialize the XPath engine, perhaps because of an invalid query: //"); + scanFile("/checks/xpath.mc", check); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifierRuleTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifierRuleTest.java new file mode 100644 index 0000000000..f6069b6057 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifierRuleTest.java @@ -0,0 +1,78 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import static org.mockito.Mockito.mock; +import org.sonar.cxx.squidbridge.api.CheckMessage; + +public class CheckMessagesVerifierRuleTest { + + @Rule + public ExpectedException thrown = ExpectedException.none(); + + @Test + public void shouldNotFailIfNothingToVerify() { + CheckMessagesVerifierRule rule = new CheckMessagesVerifierRule(); + rule.verify(); + } + + @Test + public void shouldNotFailIfVerificationsWereSuccessful() { + CheckMessagesVerifierRule rule = new CheckMessagesVerifierRule(); + rule.verify(Collections.EMPTY_LIST); + rule.verify(Collections.EMPTY_LIST); + rule.verify(); + } + + @Test + public void shouldFailIfFirstVerificationFailed() { + thrown.expect(AssertionError.class); + thrown.expectMessage("\nNo more violations expected\ngot:"); + + Collection messages = Arrays.asList(mock(CheckMessage.class)); + CheckMessagesVerifierRule rule = new CheckMessagesVerifierRule(); + rule.verify(messages); + rule.verify(Collections.EMPTY_LIST); + rule.verify(); + } + + @Test + public void shouldFailIfSecondVerificationFailed() { + thrown.expect(AssertionError.class); + thrown.expectMessage("\nNo more violations expected\ngot:"); + + Collection messages = Arrays.asList(mock(CheckMessage.class)); + CheckMessagesVerifierRule rule = new CheckMessagesVerifierRule(); + rule.verify(Collections.EMPTY_LIST); + rule.verify(messages); + rule.verify(); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifierTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifierTest.java new file mode 100644 index 0000000000..d8dd5cbd20 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/CheckMessagesVerifierTest.java @@ -0,0 +1,154 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.Locale; +import static org.hamcrest.Matchers.allOf; +import static org.hamcrest.Matchers.containsString; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.mockito.Mockito; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; +import org.sonar.cxx.squidbridge.api.CheckMessage; + +public class CheckMessagesVerifierTest { + + @Rule + public ExpectedException thrown = ExpectedException.none(); + + @Test + public void next() { + thrown.expect(AssertionError.class); + thrown.expectMessage("\nExpected violation"); + + CheckMessagesVerifier.verify(Collections.EMPTY_LIST) + .next(); + } + + @Test + public void noMore() { + thrown.expect(AssertionError.class); + thrown.expectMessage("\nNo more violations expected\ngot: at line 1"); + + Collection messages = Arrays.asList(mockCheckMessage(1, "foo")); + CheckMessagesVerifier.verify(messages) + .noMore(); + } + + @Test + public void line() { + thrown.expect(AssertionError.class); + thrown.expectMessage("\nExpected: 2\ngot: 1"); + + Collection messages = Arrays.asList(mockCheckMessage(1, "foo")); + CheckMessagesVerifier.verify(messages) + .next().atLine(2); + } + + @Test + public void line_withoutHasNext() { + thrown.expect(IllegalStateException.class); + thrown.expectMessage("Prior to this method you should call next()"); + + Collection messages = Arrays.asList(mockCheckMessage(1, "foo")); + CheckMessagesVerifier.verify(messages) + .atLine(2); + } + + @Test + public void withMessage() { + thrown.expect(AssertionError.class); + thrown.expectMessage(allOf(containsString("Expected: \"bar\""), containsString("got: \"foo\""))); + + Collection messages = Arrays.asList(mockCheckMessage(1, "foo")); + CheckMessagesVerifier.verify(messages) + .next().atLine(1).withMessage("bar"); + } + + @Test + public void withMessage_withoutHasNext() { + thrown.expect(IllegalStateException.class); + thrown.expectMessage("Prior to this method you should call next()"); + + Collection messages = Arrays.asList(mockCheckMessage(1, "foo")); + CheckMessagesVerifier.verify(messages) + .withMessage("foo"); + } + + //@Test todo + public void withMessageThat() { + thrown.expect(AssertionError.class); + thrown.expectMessage("\nExpected: a string containing \"bar\"\n got: \"foo\""); + + Collection messages = Arrays.asList(mockCheckMessage(1, "foo")); + CheckMessagesVerifier.verify(messages) + .next().atLine(1).withMessageThat(containsString("bar")); + } + + @Test + public void withCost() { + thrown.expect(AssertionError.class); + thrown.expectMessage(allOf(containsString("Expected: 1.0"), containsString("got: 0.0"))); + + Collection messages = Arrays.asList(mockCheckMessage(1, "foo", 0d)); + CheckMessagesVerifier.verify(messages) + .next().withCost(1d); + } + + @Test + public void ok() { + Collection messages = Arrays.asList( + mockCheckMessage(null, "b"), + mockCheckMessage(2, "a", 1d), + mockCheckMessage(null, "a"), + mockCheckMessage(1, "b"), + mockCheckMessage(1, "a")); + CheckMessagesVerifier.verify(messages) + .next().atLine(null).withMessage("a") + .next().atLine(null).withMessageThat(containsString("b")) + .next().atLine(1).withMessage("a") + .next().atLine(1).withMessage("b") + .next().atLine(2).withMessage("a").withCost(1d) + .noMore(); + } + + private static final CheckMessage mockCheckMessage(Integer line, String message, Double cost) { + CheckMessage checkMessage = mock(CheckMessage.class); + when(checkMessage.getLine()).thenReturn(line); + when(checkMessage.getDefaultMessage()).thenReturn(message); + when(checkMessage.getText(Mockito.any(Locale.class))).thenReturn(message); + when(checkMessage.getCost()).thenReturn(cost); + return checkMessage; + } + + private static final CheckMessage mockCheckMessage(Integer line, String message) { + return mockCheckMessage(line, message, null); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/ChecksHelperTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/ChecksHelperTest.java new file mode 100644 index 0000000000..b8ed23f115 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/ChecksHelperTest.java @@ -0,0 +1,40 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import java.lang.reflect.Constructor; +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Test; + +public class ChecksHelperTest { + + @Test + public void private_constructor() throws Exception { + Constructor constructor = ChecksHelper.class.getDeclaredConstructor(); + assertThat(constructor.isAccessible()).isFalse(); + constructor.setAccessible(true); + constructor.newInstance(); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/ResourceParser.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/ResourceParser.java new file mode 100644 index 0000000000..18d6dc24b4 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/ResourceParser.java @@ -0,0 +1,49 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.Grammar; +import java.io.File; +import org.apache.commons.io.FileUtils; +import static org.fest.assertions.Assertions.assertThat; +import org.sonar.cxx.squidbridge.AstScanner; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.indexer.QueryByType; +import org.sonar.cxx.squidbridge.test.miniC.MiniCAstScanner; + +public class ResourceParser { + + public static SourceFile scanFile(String filePath, SquidAstVisitor... visitors) { + AstScanner scanner = MiniCAstScanner.create(visitors); + File file = FileUtils.toFile(ResourceParser.class.getResource(filePath)); + if (file == null || !file.exists()) { + throw new IllegalArgumentException("The file located under \"" + filePath + "\" was not found."); + } + scanner.scanFile(file); + assertThat(scanner.getIndex().search(new QueryByType(SourceFile.class)).size()).isEqualTo(1); + return (SourceFile) scanner.getIndex().search(new QueryByType(SourceFile.class)).iterator().next(); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/SquidCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/SquidCheckTest.java new file mode 100644 index 0000000000..b329f3db68 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/SquidCheckTest.java @@ -0,0 +1,38 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Test; + +public class SquidCheckTest { + + @Test + public void test_getKey() { + SquidCheck squidCheck = new SquidCheck() { + }; + assertThat(squidCheck.getKey()).isNull(); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/ViolationCounterCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/ViolationCounterCheckTest.java new file mode 100644 index 0000000000..699d3c1dbc --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/checks/ViolationCounterCheckTest.java @@ -0,0 +1,77 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.checks; + +import com.sonar.sslr.api.Grammar; +import java.io.File; +import org.apache.commons.io.FileUtils; +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.TemporaryFolder; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class ViolationCounterCheckTest { + + @Rule + public TemporaryFolder temporaryFolder = new TemporaryFolder(); + + @Test + public void test() throws Exception { + String projectsDir = FileUtils.toFile(ResourceParser.class.getResource("/checks/parse_error.mc")).getParentFile() + .getAbsolutePath(); + + File output = temporaryFolder.newFile(); + + ViolationCounterCheck.ViolationCounter counter = new ViolationCounterCheck.ViolationCounter(); + ViolationCounterCheck violationCounterCheck = new ViolationCounterCheck(projectsDir, counter); + + AbstractParseErrorCheck parseErrorCheck = new AbstractParseErrorCheck() { + }; + + scanFile("/checks/parse_error.mc", parseErrorCheck, violationCounterCheck); + + counter.saveToFile(output.getAbsolutePath()); + assertThat(output).isFile(); + + ViolationCounterCheck.ViolationDifferenceAnalyzer analyzer = new ViolationCounterCheck.ViolationDifferenceAnalyzer( + new ViolationCounterCheck.ViolationCounter(), + ViolationCounterCheck.ViolationCounter.loadFromFile(output)); + analyzer.printReport(); + assertThat(analyzer.hasDifferences()).isTrue(); + + analyzer = new ViolationCounterCheck.ViolationDifferenceAnalyzer( + ViolationCounterCheck.ViolationCounter.loadFromFile(output), + new ViolationCounterCheck.ViolationCounter()); + analyzer.printReport(); + assertThat(analyzer.hasDifferences()).isTrue(); + + analyzer = new ViolationCounterCheck.ViolationDifferenceAnalyzer( + ViolationCounterCheck.ViolationCounter.loadFromFile(output), + ViolationCounterCheck.ViolationCounter.loadFromFile(output)); + analyzer.printReport(); + assertThat(analyzer.hasDifferences()).isFalse(); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/indexer/SquidIndexTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/indexer/SquidIndexTest.java new file mode 100644 index 0000000000..5dccc8c24b --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/indexer/SquidIndexTest.java @@ -0,0 +1,113 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.indexer; + +import java.util.Collection; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; +import org.junit.Before; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourceClass; +import org.sonar.cxx.squidbridge.api.SourceCode; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourcePackage; +import org.sonar.cxx.squidbridge.api.SourceProject; +import org.sonar.cxx.squidbridge.indexer.QueryByMeasure.Operator; +import org.sonar.cxx.squidbridge.measures.Metric; + +public class SquidIndexTest { + + private SquidIndex indexer; + private SourceProject project; + private SourcePackage packSquid; + private SourceFile fileSquid; + private SourceFile file2Squid; + private SourceCode classSquid; + + @Before + public void setup() { + indexer = new SquidIndex(); + project = new SourceProject("Squid Project"); + indexer.index(project); + packSquid = new SourcePackage("org.sonar.squid"); + project.addChild(packSquid); + fileSquid = new SourceFile("org.sonar.squid.Squid.java", "Squid.java"); + packSquid.addChild(fileSquid); + file2Squid = new SourceFile("org.sonar.squid.SquidConfiguration.java", "SquidConfiguration.java"); + packSquid.addChild(file2Squid); + classSquid = new SourceClass("org.sonar.squid.Squid", "Squid"); + fileSquid.addChild(classSquid); + } + + @Test + public void searchSingleResource() { + SourceCode squidClass = indexer.search("org.sonar.squid.Squid"); + assertEquals(new SourceClass("org.sonar.squid.Squid", "Squid"), squidClass); + SourceCode javaNCSSClass = indexer.search("org.sonar.squid.JavaNCSS"); + assertNull(javaNCSSClass); + } + + @Test + public void searchByType() { + Collection resources = indexer.search(new QueryByType(SourceFile.class)); + assertEquals(2, resources.size()); + resources = indexer.search(new QueryByType(SourceClass.class)); + assertEquals(1, resources.size()); + assertTrue(resources.contains(classSquid)); + } + + @Test + public void searchByName() { + Collection resources = indexer.search(new QueryByName("Squid.java")); + assertEquals(1, resources.size()); + assertTrue(resources.contains(fileSquid)); + } + + @Test + public void searchByParent() { + Collection resources = indexer.search(new QueryByParent(packSquid)); + assertEquals(3, resources.size()); + } + + @Test + public void searchByParentAndByType() { + Collection resources = indexer.search(new QueryByParent(packSquid), new QueryByType(SourceClass.class)); + assertEquals(1, resources.size()); + assertTrue(resources.contains(classSquid)); + } + + @Test + public void searchByMeasure() { + fileSquid.add(Metric.COMPLEXITY, 2); + assertEquals(1, indexer.search(new QueryByMeasure(Metric.COMPLEXITY, Operator.GREATER_THAN, 1)).size()); + assertEquals(1, indexer.search(new QueryByMeasure(Metric.COMPLEXITY, Operator.GREATER_THAN_EQUALS, 2)).size()); + assertEquals(0, indexer.search(new QueryByMeasure(Metric.COMPLEXITY, Operator.GREATER_THAN, 3)).size()); + assertEquals(4, indexer.search(new QueryByMeasure(Metric.COMPLEXITY, Operator.LESS_THAN, 1)).size()); + assertEquals(5, indexer.search(new QueryByMeasure(Metric.COMPLEXITY, Operator.LESS_THAN, 3)).size()); + assertEquals(5, indexer.search(new QueryByMeasure(Metric.COMPLEXITY, Operator.LESS_THAN_EQUALS, 2)).size()); + assertEquals(0, indexer.search(new QueryByMeasure(Metric.COMPLEXITY, Operator.EQUALS, 6)).size()); + assertEquals(1, indexer.search(new QueryByMeasure(Metric.COMPLEXITY, Operator.EQUALS, 2)).size()); + } +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/AbstractnessFormulaTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/AbstractnessFormulaTest.java new file mode 100644 index 0000000000..36e580bb7c --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/AbstractnessFormulaTest.java @@ -0,0 +1,53 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import static org.junit.Assert.assertEquals; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourcePackage; + +public class AbstractnessFormulaTest { + + AbstractnessFormula abstractness = new AbstractnessFormula(); + SourcePackage measurable = new SourcePackage("pac1"); + + @Test + public void testCalculate() { + measurable.setMeasure(Metric.CLASSES, 10); + measurable.setMeasure(Metric.INTERFACES, 1); + measurable.setMeasure(Metric.ABSTRACT_CLASSES, 1); + + assertEquals(0.2, abstractness.calculate(measurable), 0); + } + + @Test + public void testCalculateOnEmptyProject() { + measurable.setMeasure(Metric.CLASSES, 0); + measurable.setMeasure(Metric.INTERFACES, 0); + measurable.setMeasure(Metric.ABSTRACT_CLASSES, 0); + + assertEquals(0, abstractness.calculate(measurable), 0); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/CommentLinesDensityFormulaTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/CommentLinesDensityFormulaTest.java new file mode 100644 index 0000000000..b609e5a46b --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/CommentLinesDensityFormulaTest.java @@ -0,0 +1,49 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import static org.junit.Assert.assertEquals; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourceClass; + +public class CommentLinesDensityFormulaTest { + + CommentLinesDensityFormula formula = new CommentLinesDensityFormula(); + SourceClass measurable = new SourceClass("com.Toto"); + + @Test + public void calculateDensityOnEmptyFile() { + measurable.setMeasure(Metric.LINES_OF_CODE, 0); + measurable.setMeasure(Metric.COMMENT_LINES, 0); + assertEquals(0, measurable.getDouble(Metric.COMMENT_LINES_DENSITY), 0.01); + } + + @Test + public void calculate() { + measurable.setMeasure(Metric.LINES_OF_CODE, 10); + measurable.setMeasure(Metric.COMMENT_LINES, 10); + assertEquals(0.5, measurable.getDouble(Metric.COMMENT_LINES_DENSITY), 0.01); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/CommentLinesWithoutHeaderFormulaTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/CommentLinesWithoutHeaderFormulaTest.java new file mode 100644 index 0000000000..4e5cf1bf0c --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/CommentLinesWithoutHeaderFormulaTest.java @@ -0,0 +1,41 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import static org.junit.Assert.assertEquals; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourceClass; + +public class CommentLinesWithoutHeaderFormulaTest { + + CommentLinesWithoutHeaderFormula formula = new CommentLinesWithoutHeaderFormula(); + SourceClass measurable = new SourceClass("com.Toto"); + + @Test + public void calculateDensityOnEmptyFile() { + measurable.setMeasure(Metric.COMMENT_LINES, 10); + measurable.setMeasure(Metric.HEADER_COMMENT_LINES, 5); + assertEquals(5, measurable.getInt(Metric.COMMENT_LINES_WITHOUT_HEADER)); + } +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/DistanceFormulaTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/DistanceFormulaTest.java new file mode 100644 index 0000000000..6c848f9255 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/DistanceFormulaTest.java @@ -0,0 +1,52 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import static org.junit.Assert.assertEquals; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourcePackage; + +public class DistanceFormulaTest { + + DistanceFormula distance = new DistanceFormula(); + SourcePackage measurable = new SourcePackage("pac1"); + + @Test + public void calculateBestDistance() { + measurable.setMeasure(Metric.CLASSES, 5); + measurable.setMeasure(Metric.INTERFACES, 5); + measurable.setMeasure(Metric.CA, 10); + measurable.setMeasure(Metric.CE, 10); + assertEquals(0.5, measurable.getDouble(Metric.DISTANCE), 0.01); + } + + @Test + public void calculateWorstDistance() { + measurable.setMeasure(Metric.CLASSES, 5); + measurable.setMeasure(Metric.CA, 10); + measurable.setMeasure(Metric.CE, 0); + assertEquals(1, measurable.getDouble(Metric.DISTANCE), 0.01); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/InstabilityFormulaTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/InstabilityFormulaTest.java new file mode 100644 index 0000000000..e7703f7531 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/InstabilityFormulaTest.java @@ -0,0 +1,56 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import static org.junit.Assert.assertEquals; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourcePackage; + +public class InstabilityFormulaTest { + + InstabilityFormula distance = new InstabilityFormula(); + SourcePackage measurable = new SourcePackage("pac1"); + + @Test + public void calculateBestStability() { + measurable.setMeasure(Metric.CA, 50); + measurable.setMeasure(Metric.CE, 0); + assertEquals(0, measurable.getDouble(Metric.INSTABILITY), 0.01); + } + + @Test + public void calculateWorstStability() { + measurable.setMeasure(Metric.CA, 0); + measurable.setMeasure(Metric.CE, 10); + assertEquals(1, measurable.getDouble(Metric.INSTABILITY), 0.01); + } + + @Test + public void calculateOnIsolatedProject() { + measurable.setMeasure(Metric.CA, 0); + measurable.setMeasure(Metric.CE, 0); + assertEquals(0, measurable.getDouble(Metric.INSTABILITY), 0.01); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/MeanAggregationFormulaTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/MeanAggregationFormulaTest.java new file mode 100644 index 0000000000..dec37e2387 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/MeanAggregationFormulaTest.java @@ -0,0 +1,55 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import java.util.ArrayList; +import java.util.List; +import static org.junit.Assert.assertEquals; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourceClass; + +public class MeanAggregationFormulaTest { + + MeanAggregationFormula formula = new MeanAggregationFormula(); + + @Test + public void testAggregate() { + List measurables = new ArrayList(); + SourceClass class1 = new SourceClass("com.My"); + class1.setMeasure(Metric.COMPLEXITY, 2); + measurables.add(class1); + SourceClass class2 = new SourceClass("com.My"); + class2.setMeasure(Metric.COMPLEXITY, 3); + measurables.add(class2); + + assertEquals(2.5, formula.aggregate(Metric.COMPLEXITY, measurables), 0.01); + } + + @Test + public void testAggregateEmptyCollections() { + List measurables = new ArrayList(); + assertEquals(0, formula.aggregate(Metric.COMPLEXITY, measurables), 0.01); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/MeasuresTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/MeasuresTest.java new file mode 100644 index 0000000000..d266673ba5 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/MeasuresTest.java @@ -0,0 +1,56 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import org.junit.Test; + +public class MeasuresTest { + + private final Measures measures = new Measures(); + + @Test + public void testGetValue() { + assertEquals(0, measures.getValue(Metric.ACCESSORS), 0.1); + } + + @Test + public void testGetData() { + assertNull(measures.getData(Metric.LCOM4_BLOCKS)); + } + + @Test + public void testSetValue() { + measures.setValue(Metric.ACCESSORS, 3); + assertEquals(3, measures.getValue(Metric.ACCESSORS), 0.1); + } + + @Test + public void testSetData() { + measures.setData(Metric.LCOM4_BLOCKS, "blocks detail"); + assertEquals("blocks detail", measures.getData(Metric.LCOM4_BLOCKS)); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/PublicDocumentedApiDensityFormulaTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/PublicDocumentedApiDensityFormulaTest.java new file mode 100644 index 0000000000..548e0bdbe6 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/PublicDocumentedApiDensityFormulaTest.java @@ -0,0 +1,49 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import static org.junit.Assert.assertEquals; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourceClass; + +public class PublicDocumentedApiDensityFormulaTest { + + PublicDocumentedApiDensityFormula formula = new PublicDocumentedApiDensityFormula(); + SourceClass measurable = new SourceClass("com.Toto"); + + @Test + public void calculateWhenNoPublicApi() { + measurable.setMeasure(Metric.PUBLIC_API, 0); + measurable.setMeasure(Metric.PUBLIC_DOC_API, 0); + assertEquals(1, measurable.getDouble(Metric.PUBLIC_DOCUMENTED_API_DENSITY), 0.01); + } + + @Test + public void calculate() { + measurable.setMeasure(Metric.PUBLIC_API, 10); + measurable.setMeasure(Metric.PUBLIC_DOC_API, 5); + assertEquals(0.5, measurable.getDouble(Metric.PUBLIC_DOCUMENTED_API_DENSITY), 0.01); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/SumAggregationFormulaTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/SumAggregationFormulaTest.java new file mode 100644 index 0000000000..9cfea92c97 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/measures/SumAggregationFormulaTest.java @@ -0,0 +1,55 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.measures; + +import java.util.ArrayList; +import java.util.List; +import static org.junit.Assert.assertEquals; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourceClass; + +public class SumAggregationFormulaTest { + + SumAggregationFormula formula = new SumAggregationFormula(); + + @Test + public void testAggregate() { + List measurables = new ArrayList(); + SourceClass class1 = new SourceClass("com.My"); + class1.setMeasure(Metric.COMPLEXITY, 2); + measurables.add(class1); + SourceClass class2 = new SourceClass("com.My"); + class2.setMeasure(Metric.COMPLEXITY, 3); + measurables.add(class2); + + assertEquals(5, formula.aggregate(Metric.COMPLEXITY, measurables), 0.01); + } + + @Test + public void testAggregateEmptyCollections() { + List measurables = new ArrayList(); + assertEquals(0, formula.aggregate(Metric.COMPLEXITY, measurables), 0.01); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/CommentsVisitorTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/CommentsVisitorTest.java new file mode 100644 index 0000000000..c328380c7a --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/CommentsVisitorTest.java @@ -0,0 +1,62 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.metrics; + +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourceFile; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFileIgnoreHeaderComments; +import org.sonar.cxx.squidbridge.test.miniC.MiniCAstScanner.MiniCMetrics; + +public class CommentsVisitorTest { + + @Test + public void empty() { + SourceFile sourceFile = scanFile("/metrics/comments_none.mc"); + + assertThat(sourceFile.getInt(MiniCMetrics.COMMENT_LINES)).isEqualTo(0); + + assertThat(sourceFile.getNoSonarTagLines().size()).isEqualTo(0); + } + + @Test + public void comments() { + SourceFile sourceFile = scanFile("/metrics/comments.mc"); + + assertThat(sourceFile.getInt(MiniCMetrics.COMMENT_LINES)).isEqualTo(3); + + assertThat(sourceFile.getNoSonarTagLines().size()).isEqualTo(2); + assertThat(sourceFile.getNoSonarTagLines()).containsOnly(5, 6); + } + + @Test + public void headerComments() { + SourceFile sourceFile = scanFileIgnoreHeaderComments("/metrics/header_comments.mc"); + + assertThat(sourceFile.getInt(MiniCMetrics.COMMENT_LINES)).isEqualTo(1); + assertThat(sourceFile.getNoSonarTagLines().size()).isEqualTo(0); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/ComplexityVisitorTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/ComplexityVisitorTest.java new file mode 100644 index 0000000000..30f740bcf8 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/ComplexityVisitorTest.java @@ -0,0 +1,43 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.metrics; + +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourceFile; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; +import org.sonar.cxx.squidbridge.test.miniC.MiniCAstScanner.MiniCMetrics; + +public class ComplexityVisitorTest { + + @Test + public void counter() { + SourceFile sourceFile = scanFile("/metrics/complexity.mc"); + + assertThat(sourceFile.getInt(MiniCMetrics.COMPLEXITY)).isEqualTo(4); + assertThat(sourceFile.getInt(MiniCMetrics.STATEMENTS)).isEqualTo(11); + assertThat(sourceFile.getInt(MiniCMetrics.FUNCTIONS)).isEqualTo(2); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/CounterVisitorTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/CounterVisitorTest.java new file mode 100644 index 0000000000..4772b174b6 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/CounterVisitorTest.java @@ -0,0 +1,43 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.metrics; + +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourceFile; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; +import org.sonar.cxx.squidbridge.test.miniC.MiniCAstScanner.MiniCMetrics; + +public class CounterVisitorTest { + + @Test + public void counter() { + SourceFile sourceFile = scanFile("/metrics/counter.mc"); + + assertThat(sourceFile.getInt(MiniCMetrics.COMPLEXITY)).isEqualTo(4); + assertThat(sourceFile.getInt(MiniCMetrics.STATEMENTS)).isEqualTo(6); + assertThat(sourceFile.getInt(MiniCMetrics.FUNCTIONS)).isEqualTo(2); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/LinesOfCodeVisitorTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/LinesOfCodeVisitorTest.java new file mode 100644 index 0000000000..a1cc31ebbf --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/LinesOfCodeVisitorTest.java @@ -0,0 +1,41 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.metrics; + +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourceFile; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; +import org.sonar.cxx.squidbridge.test.miniC.MiniCAstScanner.MiniCMetrics; + +public class LinesOfCodeVisitorTest { + + @Test + public void linesOfCode() { + SourceFile sourceFile = scanFile("/metrics/lines_of_code.mc"); + + assertThat(sourceFile.getInt(MiniCMetrics.LINES_OF_CODE)).isEqualTo(3); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/LinesVisitorTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/LinesVisitorTest.java new file mode 100644 index 0000000000..0b99a1dbda --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/LinesVisitorTest.java @@ -0,0 +1,41 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.metrics; + +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Test; +import org.sonar.cxx.squidbridge.api.SourceFile; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; +import org.sonar.cxx.squidbridge.test.miniC.MiniCAstScanner.MiniCMetrics; + +public class LinesVisitorTest { + + @Test + public void linesOfCode() { + SourceFile sourceFile = scanFile("/metrics/lines.mc"); + + assertThat(sourceFile.getInt(MiniCMetrics.LINES)).isEqualTo(19); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/ResourceParser.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/ResourceParser.java new file mode 100644 index 0000000000..d8bfa6529e --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/metrics/ResourceParser.java @@ -0,0 +1,59 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.metrics; + +import com.sonar.sslr.api.Grammar; +import java.io.File; +import org.apache.commons.io.FileUtils; +import static org.fest.assertions.Assertions.assertThat; +import org.sonar.cxx.squidbridge.AstScanner; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.indexer.QueryByType; +import org.sonar.cxx.squidbridge.test.miniC.MiniCAstScanner; + +public class ResourceParser { + + public static SourceFile scanFile(String filePath, SquidAstVisitor... visitors) { + return scanFile(filePath, false, visitors); + } + + public static SourceFile scanFileIgnoreHeaderComments(String filePath, SquidAstVisitor... visitors) { + return scanFile(filePath, true, visitors); + } + + private static SourceFile scanFile(String filePath, boolean ignoreHeaderComments, SquidAstVisitor... visitors) { + AstScanner scanner = ignoreHeaderComments ? MiniCAstScanner.createIgnoreHeaderComments(visitors) + : MiniCAstScanner + .create(visitors); + File file = FileUtils.toFile(ResourceParser.class.getResource(filePath)); + if (file == null || !file.exists()) { + throw new IllegalArgumentException("The file located under \"" + filePath + "\" was not found."); + } + scanner.scanFile(file); + assertThat(scanner.getIndex().search(new QueryByType(SourceFile.class)).size()).isEqualTo(1); + return (SourceFile) scanner.getIndex().search(new QueryByType(SourceFile.class)).iterator().next(); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/rules/ExternalDescriptionLoaderTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/rules/ExternalDescriptionLoaderTest.java new file mode 100644 index 0000000000..24a9bfe2d1 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/rules/ExternalDescriptionLoaderTest.java @@ -0,0 +1,76 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.rules; + +import java.net.URL; +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Test; +import org.sonar.api.server.rule.RulesDefinition; +import org.sonar.api.server.rule.RulesDefinition.NewRepository; +import org.sonar.api.server.rule.RulesDefinition.NewRule; +import org.sonar.api.server.rule.RulesDefinition.Repository; +import org.sonar.api.server.rule.RulesDefinition.Rule; + +public class ExternalDescriptionLoaderTest { + + private static final String REPO_KEY = "repoKey"; + private static final String LANGUAGE_KEY = "languageKey"; + + private RulesDefinition.Context context = new RulesDefinition.Context(); + private NewRepository repository = context.createRepository(REPO_KEY, LANGUAGE_KEY); + + @Test + public void existing_rule_description() throws Exception { + repository.createRule("ruleWithExternalInfo").setName("name1"); + Rule rule = buildRepository().rule("ruleWithExternalInfo"); + assertThat(rule.htmlDescription()).isEqualTo("description for ruleWithExternalInfo"); + } + + @Test + public void rule_with_non_external_description() throws Exception { + repository.createRule("ruleWithoutExternalInfo").setName("name1").setHtmlDescription("my description"); + Rule rule = buildRepository().rule("ruleWithoutExternalInfo"); + assertThat(rule.htmlDescription()).isEqualTo("my description"); + } + + @Test(expected = IllegalStateException.class) + public void rule_without_description() throws Exception { + repository.createRule("ruleWithoutExternalInfo").setName("name1"); + buildRepository().rule("ruleWithoutExternalInfo"); + } + + @Test(expected = IllegalStateException.class) + public void invalid_url() throws Exception { + ExternalDescriptionLoader loader = new ExternalDescriptionLoader(repository, LANGUAGE_KEY); + NewRule rule = repository.createRule("ruleWithoutExternalInfo").setName("name1"); + loader.addHtmlDescription(rule, new URL("file:///xx/yy")); + } + + private Repository buildRepository() { + ExternalDescriptionLoader.loadHtmlDescriptions(repository, "/org/sonar/l10n/languageKey/rules/repoKey"); + repository.done(); + return context.repository(REPO_KEY); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/rules/PropertyFileLoaderTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/rules/PropertyFileLoaderTest.java new file mode 100644 index 0000000000..d0be4d94f7 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/rules/PropertyFileLoaderTest.java @@ -0,0 +1,89 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.rules; + +import java.io.IOException; +import java.io.InputStream; +import static org.fest.assertions.Assertions.assertThat; +import org.junit.Test; +import static org.mockito.Matchers.any; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.mock; +import org.sonar.api.server.rule.RulesDefinition; +import org.sonar.api.server.rule.RulesDefinition.NewParam; +import org.sonar.api.server.rule.RulesDefinition.NewRepository; +import org.sonar.api.server.rule.RulesDefinition.NewRule; +import org.sonar.api.server.rule.RulesDefinition.Repository; +import org.sonar.api.server.rule.RulesDefinition.Rule; + +public class PropertyFileLoaderTest { + + private static final String PARAM_KEY = "param1"; + private static final String RULE_KEY = "rule1"; + + private RulesDefinition.Context context = new RulesDefinition.Context(); + private NewRepository repository = context.createRepository("repoKey", "languageKey"); + + @Test + public void rule_and_parameter_defined_in_property_file() throws Exception { + NewRule newRule = repository.createRule(RULE_KEY); + newRule.setHtmlDescription("desc"); + newRule.createParam(PARAM_KEY); + PropertyFileLoader.loadNames(repository, "/rules/names.properties"); + Rule rule = buildRepository().rule(RULE_KEY); + assertThat(rule.name()).isEqualTo("my rule name1"); + assertThat(rule.param(PARAM_KEY).description()).isEqualTo("my param description1"); + } + + @Test + public void rule_and_parameter_not_defined_in_property_file() throws Exception { + NewRule newRule = repository.createRule(RULE_KEY); + newRule.setName("ruleName1"); + newRule.setHtmlDescription("desc"); + NewParam newParam = newRule.createParam(PARAM_KEY); + newParam.setDescription("paramName1"); + PropertyFileLoader.loadNames(repository, "/rules/empty.properties"); + Rule rule = buildRepository().rule(RULE_KEY); + assertThat(rule.name()).isEqualTo("ruleName1"); + assertThat(rule.param(PARAM_KEY).description()).isEqualTo("paramName1"); + } + + @Test(expected = IllegalArgumentException.class) + public void should_fail_if_resource_is_not_found() throws Exception { + PropertyFileLoader.loadNames(repository, "/rules/unknown.properties"); + } + + @Test(expected = IllegalArgumentException.class) + public void should_fail_if_resource_has_invalid_format() throws Exception { + InputStream stream = mock(InputStream.class); + doThrow(new IOException()).when(stream).read((byte[]) any()); + PropertyFileLoader.loadNames(repository, stream); + } + + private Repository buildRepository() { + repository.done(); + return context.repository("repoKey"); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/test/miniC/MiniCAstScanner.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/test/miniC/MiniCAstScanner.java new file mode 100644 index 0000000000..7702521ddd --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/test/miniC/MiniCAstScanner.java @@ -0,0 +1,185 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.test.miniC; + +import com.sonar.sslr.api.AstNode; +import com.sonar.sslr.api.AstNodeType; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.impl.Parser; +import com.sonar.sslr.test.minic.MiniCGrammar; +import com.sonar.sslr.test.minic.MiniCParser; +import org.sonar.cxx.squidbridge.AstScanner; +import org.sonar.cxx.squidbridge.CommentAnalyser; +import org.sonar.cxx.squidbridge.SourceCodeBuilderCallback; +import org.sonar.cxx.squidbridge.SourceCodeBuilderVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitorContextImpl; +import org.sonar.cxx.squidbridge.api.SourceCode; +import org.sonar.cxx.squidbridge.api.SourceFunction; +import org.sonar.cxx.squidbridge.api.SourceProject; +import org.sonar.cxx.squidbridge.measures.AggregationFormula; +import org.sonar.cxx.squidbridge.measures.CalculatedMetricFormula; +import org.sonar.cxx.squidbridge.measures.MetricDef; +import org.sonar.cxx.squidbridge.measures.SumAggregationFormula; +import org.sonar.cxx.squidbridge.metrics.CommentsVisitor; +import org.sonar.cxx.squidbridge.metrics.ComplexityVisitor; +import org.sonar.cxx.squidbridge.metrics.CounterVisitor; +import org.sonar.cxx.squidbridge.metrics.LinesOfCodeVisitor; +import org.sonar.cxx.squidbridge.metrics.LinesVisitor; + +public final class MiniCAstScanner { + + public static enum MiniCMetrics implements MetricDef { + FILES, STATEMENTS, COMPLEXITY, LINES, LINES_OF_CODE, COMMENT_LINES, BLANK_COMMENT_LINES, FUNCTIONS; + + public double getInitValue() { + return 0; + } + + @Override + public String getName() { + return name(); + } + + @Override + public boolean isCalculatedMetric() { + return false; + } + + @Override + public boolean aggregateIfThereIsAlreadyAValue() { + return true; + } + + @Override + public boolean isThereAggregationFormula() { + return true; + } + + @Override + public CalculatedMetricFormula getCalculatedMetricFormula() { + return null; + } + + public AggregationFormula getAggregationFormula() { + return new SumAggregationFormula(); + } + + } + + private MiniCAstScanner() { + } + + public static AstScanner create(SquidAstVisitor... visitors) { + return create(false, visitors); + } + + public static AstScanner createIgnoreHeaderComments(SquidAstVisitor... visitors) { + return create(true, visitors); + } + + private static AstScanner create(boolean ignoreHeaderComments, SquidAstVisitor... visitors) { + + final SquidAstVisitorContextImpl context = new SquidAstVisitorContextImpl( + new SourceProject("MiniC Project")); + final Parser parser = MiniCParser.create(); + + AstScanner.Builder builder = AstScanner.builder(context).setBaseParser(parser); + + /* Metrics */ + builder.withMetrics(MiniCMetrics.values()); + + /* Comments */ + builder.setCommentAnalyser( + new CommentAnalyser() { + + @Override + public boolean isBlank(String commentLine) { + for (int i = 0; i < commentLine.length(); i++) { + if (Character.isLetterOrDigit(commentLine.charAt(i))) { + return false; + } + } + + return true; + } + + @Override + public String getContents(String comment) { + return comment.substring(2, comment.length() - 2); + } + + } + ); + + /* Files */ + builder.setFilesMetric(MiniCMetrics.FILES); + + /* Functions */ + builder.withSquidAstVisitor(new SourceCodeBuilderVisitor(new SourceCodeBuilderCallback() { + + @Override + public SourceCode createSourceCode(SourceCode parentSourceCode, AstNode astNode) { + String functionName = astNode.findFirstChild(MiniCGrammar.BIN_FUNCTION_DEFINITION).getTokenValue(); + + SourceFunction function = new SourceFunction(astNode.getFromIndex() + "@" + functionName); + function.setStartAtLine(astNode.getTokenLine()); + + return function; + } + }, MiniCGrammar.FUNCTION_DEFINITION)); + + builder.withSquidAstVisitor(CounterVisitor.builder().setMetricDef(MiniCMetrics.FUNCTIONS) + .subscribeTo(MiniCGrammar.FUNCTION_DEFINITION).build()); + + /* Metrics */ + builder.withSquidAstVisitor(new LinesVisitor(MiniCMetrics.LINES)); + builder.withSquidAstVisitor(new LinesOfCodeVisitor(MiniCMetrics.LINES_OF_CODE)); + builder.withSquidAstVisitor(CommentsVisitor.builder().withCommentMetric(MiniCMetrics.COMMENT_LINES) + .withNoSonar(true) + .withIgnoreHeaderComment(ignoreHeaderComments) + .build()); + builder.withSquidAstVisitor(CounterVisitor.builder().setMetricDef(MiniCMetrics.STATEMENTS) + .subscribeTo(MiniCGrammar.STATEMENT).build()); + + AstNodeType[] complexityAstNodeType = new AstNodeType[]{ + MiniCGrammar.FUNCTION_DEFINITION, + MiniCGrammar.RETURN_STATEMENT, + MiniCGrammar.IF_STATEMENT, + MiniCGrammar.WHILE_STATEMENT, + MiniCGrammar.CONTINUE_STATEMENT, + MiniCGrammar.BREAK_STATEMENT + }; + builder.withSquidAstVisitor(ComplexityVisitor.builder().setMetricDef(MiniCMetrics.COMPLEXITY) + .subscribeTo(complexityAstNodeType).addExclusions(MiniCGrammar.NO_COMPLEXITY_STATEMENT).build()); + + /* External visitors (typically Check ones) */ + for (SquidAstVisitor visitor : visitors) { + builder.withSquidAstVisitor(visitor); + } + + return builder.build(); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/test/miniC/fakeChecks/FakeCommentCheckTest.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/test/miniC/fakeChecks/FakeCommentCheckTest.java new file mode 100644 index 0000000000..822814e9cb --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/test/miniC/fakeChecks/FakeCommentCheckTest.java @@ -0,0 +1,58 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.test.miniC.fakeChecks; + +import com.sonar.sslr.api.AstAndTokenVisitor; +import com.sonar.sslr.api.Grammar; +import com.sonar.sslr.api.Token; +import com.sonar.sslr.api.Trivia; +import org.junit.Rule; +import org.junit.Test; +import org.sonar.cxx.squidbridge.checks.CheckMessagesVerifierRule; +import org.sonar.cxx.squidbridge.checks.SquidCheck; +import static org.sonar.cxx.squidbridge.metrics.ResourceParser.scanFile; + +public class FakeCommentCheckTest { + + @Rule + public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule(); + + private class FakeCommentCheck extends SquidCheck implements AstAndTokenVisitor { + + public void visitToken(Token token) { + for (Trivia trivia : token.getTrivia()) { + if (trivia.isComment() && trivia.getToken().getValue().contains("stupid")) { + getContext().createLineViolation(this, "Be gentle in your comments.", trivia.getToken().getLine()); + } + } + } + } + + @Test + public void testFakeCommentCheck() { + checkMessagesVerifier.verify(scanFile("/fakeChecks/fakeComment.mc", new FakeCommentCheck()).getCheckMessages()) + .next().atLine(6); + } + +} diff --git a/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/test/miniC/fakeChecks/ResourceParser.java b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/test/miniC/fakeChecks/ResourceParser.java new file mode 100644 index 0000000000..55c130ff89 --- /dev/null +++ b/cxx-squid-bridge/src/test/java/org/sonar/cxx/squidbridge/test/miniC/fakeChecks/ResourceParser.java @@ -0,0 +1,49 @@ +/* + * C++ Community Plugin (cxx plugin) + * Copyright (C) 2021 SonarOpenCommunity + * http://github.com/SonarOpenCommunity/sonar-cxx + * + * This program 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. + * + * This program 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 this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +/** + * fork of SSLR Squid Bridge: https://github.com/SonarSource/sslr-squid-bridge/tree/2.6.1 + * Copyright (C) 2010 SonarSource / mailto: sonarqube@googlegroups.com / license: LGPL v3 + */ +package org.sonar.cxx.squidbridge.test.miniC.fakeChecks; + +import com.sonar.sslr.api.Grammar; +import java.io.File; +import org.apache.commons.io.FileUtils; +import static org.fest.assertions.Assertions.assertThat; +import org.sonar.cxx.squidbridge.AstScanner; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.indexer.QueryByType; +import org.sonar.cxx.squidbridge.test.miniC.MiniCAstScanner; + +public class ResourceParser { + + public static SourceFile scanFile(String filePath, SquidAstVisitor... visitors) { + AstScanner scanner = MiniCAstScanner.create(visitors); + File file = FileUtils.toFile(ResourceParser.class.getResource(filePath)); + if (file == null || !file.exists()) { + throw new IllegalArgumentException("The file located under \"" + filePath + "\" was not found."); + } + scanner.scanFile(file); + assertThat(scanner.getIndex().search(new QueryByType(SourceFile.class)).size()).isEqualTo(1); + return (SourceFile) scanner.getIndex().search(new QueryByType(SourceFile.class)).iterator().next(); + } + +} diff --git a/cxx-squid-bridge/src/test/resources/checks/commentRegularExpression.mc b/cxx-squid-bridge/src/test/resources/checks/commentRegularExpression.mc new file mode 100644 index 0000000000..fd66959c9f --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/commentRegularExpression.mc @@ -0,0 +1,10 @@ +/* my comment */ + +int foo = 42; /* TODO fix me */ + +/* todo */ + +/* + + toDo + */ diff --git a/cxx-squid-bridge/src/test/resources/checks/complexity5.mc b/cxx-squid-bridge/src/test/resources/checks/complexity5.mc new file mode 100644 index 0000000000..61d757df30 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/complexity5.mc @@ -0,0 +1,7 @@ +int myfunction() +{ + return 2; + return 3; + return 4; + return 5; +} diff --git a/cxx-squid-bridge/src/test/resources/checks/goto.mc b/cxx-squid-bridge/src/test/resources/checks/goto.mc new file mode 100644 index 0000000000..87e600f35a --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/goto.mc @@ -0,0 +1,14 @@ +int myfunction() +{ + int a = 10; + + while (1) + { + if (a == 0) + { + break; /* NOK */ + } + + a--; + } +} diff --git a/cxx-squid-bridge/src/test/resources/checks/line_length.mc b/cxx-squid-bridge/src/test/resources/checks/line_length.mc new file mode 100644 index 0000000000..544f295fab --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/line_length.mc @@ -0,0 +1,6 @@ +/* very long comments are not taken care of - aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa */ + +int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa81; +int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa80; + +int a7; diff --git a/cxx-squid-bridge/src/test/resources/checks/magic.mc b/cxx-squid-bridge/src/test/resources/checks/magic.mc new file mode 100644 index 0000000000..ae662bc64f --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/magic.mc @@ -0,0 +1,15 @@ +int a = 0; /* OK */ + +int myFunction() +{ + while (a > 0) /* NOK */ + { + int b = 10; /* OK */ + + a = 150; /* NOK */ + + a = 1337; /* OK, exception */ + } + + return 42; /* OK */ +} diff --git a/cxx-squid-bridge/src/test/resources/checks/naming.mc b/cxx-squid-bridge/src/test/resources/checks/naming.mc new file mode 100644 index 0000000000..9bce253fbd --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/naming.mc @@ -0,0 +1,15 @@ +int a = 0; + +int LINE = 21; + +int BAD = 23; /* NOK */ + +int myfunction() +{ + return 42; +} + +int myFunction() /* NOK */ +{ + return 42; +} diff --git a/cxx-squid-bridge/src/test/resources/checks/nested_comments.mc b/cxx-squid-bridge/src/test/resources/checks/nested_comments.mc new file mode 100644 index 0000000000..9c5180e9b1 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/nested_comments.mc @@ -0,0 +1,11 @@ +/* hehe /* */ +/* haha // */ +/* foobar */ + +/* + + okie + hehe + hoho + +*/ diff --git a/cxx-squid-bridge/src/test/resources/checks/nested_if.mc b/cxx-squid-bridge/src/test/resources/checks/nested_if.mc new file mode 100644 index 0000000000..9b35055af2 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/nested_if.mc @@ -0,0 +1,36 @@ +void myfunction() +{ + if (0) /* 1 */ + { + if (0) /* 2 */ + { + if (0) /* 3 */ + { + if (0) /* 4 */ + { + return 4; + } + } + } + } + + if (0) /* 1 */ + { + } + else + { + if (0) /* 2 */ + { + } + else + { + if (0) /* 3 */ + { + } + else + { + return 3; + } + } + } +} \ No newline at end of file diff --git a/cxx-squid-bridge/src/test/resources/checks/no_sonar.mc b/cxx-squid-bridge/src/test/resources/checks/no_sonar.mc new file mode 100644 index 0000000000..120668f979 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/no_sonar.mc @@ -0,0 +1,11 @@ +int a = 0; + +/* line 1 + line 2 + NOSONAR line 3 + line 4 NOSONAR this is also a no sonar even if not at the beginning */ + +void myfunction() +{ + int b = a + 42; /* NOSONAR */ +} diff --git a/cxx-squid-bridge/src/test/resources/checks/one_statement_per_line.mc b/cxx-squid-bridge/src/test/resources/checks/one_statement_per_line.mc new file mode 100644 index 0000000000..fdee53cc6e --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/one_statement_per_line.mc @@ -0,0 +1,8 @@ +int myFunction() +{ + if (0) { /* This is acceptable, and must be excluded */ + return 0; + } + + if (1) return 1; /* This however is not acceptable, NOK */ +} diff --git a/cxx-squid-bridge/src/test/resources/checks/parse_error.mc b/cxx-squid-bridge/src/test/resources/checks/parse_error.mc new file mode 100644 index 0000000000..3099db4839 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/parse_error.mc @@ -0,0 +1,5 @@ +int myfunction +( +{ + return 4; +} diff --git a/cxx-squid-bridge/src/test/resources/checks/single_line_comments_syntax.mc b/cxx-squid-bridge/src/test/resources/checks/single_line_comments_syntax.mc new file mode 100644 index 0000000000..4293f936ba --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/single_line_comments_syntax.mc @@ -0,0 +1,17 @@ +/* single line comment */ + +/* + multi line comment +*/ + +/* + + multiple line comments + hehe + haha + +*/ + +/* single line again */ + +/* this one is acceptable */ int a; diff --git a/cxx-squid-bridge/src/test/resources/checks/xpath.mc b/cxx-squid-bridge/src/test/resources/checks/xpath.mc new file mode 100644 index 0000000000..058f8d27f9 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/checks/xpath.mc @@ -0,0 +1,7 @@ +int answer = 42; + +void myFunction() +{ + int question = 0; + return answer; +} diff --git a/cxx-squid-bridge/src/test/resources/fakeChecks/fakeComment.mc b/cxx-squid-bridge/src/test/resources/fakeChecks/fakeComment.mc new file mode 100644 index 0000000000..fd1fd26d73 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/fakeChecks/fakeComment.mc @@ -0,0 +1,9 @@ + + +/* this comment is okay */ + + +/* ARE YOU stupid OR WHAT?! */ + + + diff --git a/cxx-squid-bridge/src/test/resources/fakeChecks/fakePreprocessor.mc b/cxx-squid-bridge/src/test/resources/fakeChecks/fakePreprocessor.mc new file mode 100644 index 0000000000..f0cdffe9f0 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/fakeChecks/fakePreprocessor.mc @@ -0,0 +1,7 @@ + +#define WTF /* NOK */ + +#define HEHE + +#define OMG + diff --git a/cxx-squid-bridge/src/test/resources/metrics/comments.mc b/cxx-squid-bridge/src/test/resources/metrics/comments.mc new file mode 100644 index 0000000000..87eb450f9f --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/metrics/comments.mc @@ -0,0 +1,17 @@ +int a = 0; + +/* line 1 + line 2 + NOSONAR line 3 + line 4 NOSONAR this is also a no sonar even if not at the beginning */ + +/* line 5 */ + +/* + + */ + +void myfunction() +{ + int b = a + 42; +} diff --git a/cxx-squid-bridge/src/test/resources/metrics/comments_none.mc b/cxx-squid-bridge/src/test/resources/metrics/comments_none.mc new file mode 100644 index 0000000000..b75a552319 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/metrics/comments_none.mc @@ -0,0 +1,6 @@ +int a = 0; + +void myfunction() +{ + int b = a + 42; +} diff --git a/cxx-squid-bridge/src/test/resources/metrics/complexity.mc b/cxx-squid-bridge/src/test/resources/metrics/complexity.mc new file mode 100644 index 0000000000..41207bb8ce --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/metrics/complexity.mc @@ -0,0 +1,26 @@ +int a = 0; + +void myfunction() +{ + while (a >= 0) /* This is the while statement */ + { /* This is a compound statement */ + int b = 0; + + a--; + b++; + a = 0; + } +} + +int constant() +{ + nocomplexity + { + if (a == 42) + { + return 2; + } + } + + return 42; +} diff --git a/cxx-squid-bridge/src/test/resources/metrics/counter.mc b/cxx-squid-bridge/src/test/resources/metrics/counter.mc new file mode 100644 index 0000000000..7b0fd5bf2a --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/metrics/counter.mc @@ -0,0 +1,18 @@ +int a = 0; + +void myfunction() +{ + while (a >= 0) /* This is the while statement */ + { /* This is a compound statement */ + int b = 0; + + a--; + b++; + a = 0; + } +} + +int constant() +{ + return 42; +} diff --git a/cxx-squid-bridge/src/test/resources/metrics/header_comments.mc b/cxx-squid-bridge/src/test/resources/metrics/header_comments.mc new file mode 100644 index 0000000000..dc1babb2aa --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/metrics/header_comments.mc @@ -0,0 +1,16 @@ +/* + * NOSONAR Copyright 2012 SonarSource SA + * http://www.SonarSource.com + */ + +/* This is also part of the header */ + +int a = 0; + +void myfunction() +{ + int b = a + 42; + +/* But this is not! */ +/* */ +} diff --git a/cxx-squid-bridge/src/test/resources/metrics/lines.mc b/cxx-squid-bridge/src/test/resources/metrics/lines.mc new file mode 100644 index 0000000000..e80107b0ad --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/metrics/lines.mc @@ -0,0 +1,18 @@ +int a = 0; + + + + +int b = 1; + +/* + + + + + + +*/ + + +int c = 0; diff --git a/cxx-squid-bridge/src/test/resources/metrics/lines_of_code.mc b/cxx-squid-bridge/src/test/resources/metrics/lines_of_code.mc new file mode 100644 index 0000000000..e80107b0ad --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/metrics/lines_of_code.mc @@ -0,0 +1,18 @@ +int a = 0; + + + + +int b = 1; + +/* + + + + + + +*/ + + +int c = 0; diff --git a/cxx-squid-bridge/src/test/resources/org/sonar/l10n/languageKey.properties b/cxx-squid-bridge/src/test/resources/org/sonar/l10n/languageKey.properties new file mode 100644 index 0000000000..fafa9e9b07 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/org/sonar/l10n/languageKey.properties @@ -0,0 +1,2 @@ +rule.repoKey.ruleWithExternalInfo.name=external name for ruleWithExternalInfo +rule.repoKey.ruleWithExternalInfo.param.param1Key=description for param1 diff --git a/cxx-squid-bridge/src/test/resources/org/sonar/l10n/languageKey/rules/repoKey/ruleWithExternalInfo.html b/cxx-squid-bridge/src/test/resources/org/sonar/l10n/languageKey/rules/repoKey/ruleWithExternalInfo.html new file mode 100644 index 0000000000..b557b18e7a --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/org/sonar/l10n/languageKey/rules/repoKey/ruleWithExternalInfo.html @@ -0,0 +1 @@ +description for ruleWithExternalInfo \ No newline at end of file diff --git a/cxx-squid-bridge/src/test/resources/org/sonar/l10n/languageWithoutBundle/empty.txt b/cxx-squid-bridge/src/test/resources/org/sonar/l10n/languageWithoutBundle/empty.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/cxx-squid-bridge/src/test/resources/rules/empty.properties b/cxx-squid-bridge/src/test/resources/rules/empty.properties new file mode 100644 index 0000000000..e69de29bb2 diff --git a/cxx-squid-bridge/src/test/resources/rules/empty.xml b/cxx-squid-bridge/src/test/resources/rules/empty.xml new file mode 100644 index 0000000000..e69de29bb2 diff --git a/cxx-squid-bridge/src/test/resources/rules/names.properties b/cxx-squid-bridge/src/test/resources/rules/names.properties new file mode 100644 index 0000000000..5b0869c89a --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/rules/names.properties @@ -0,0 +1,2 @@ +rule.repoKey.rule1.name=my rule name1 +rule.repoKey.rule1.param.param1=my param description1 diff --git a/cxx-squid-bridge/src/test/resources/rules/sqale-constant.xml b/cxx-squid-bridge/src/test/resources/rules/sqale-constant.xml new file mode 100644 index 0000000000..c4710c61ac --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/rules/sqale-constant.xml @@ -0,0 +1,23 @@ + + + REUSABILITY + Reusability + + MODULARITY + Modularity + + myRepoKey + myRuleKey + + remediationFunction + CONSTANT_ISSUE + + + offset + 10 + min + + + + + \ No newline at end of file diff --git a/cxx-squid-bridge/src/test/resources/rules/sqale-linear-offset.xml b/cxx-squid-bridge/src/test/resources/rules/sqale-linear-offset.xml new file mode 100644 index 0000000000..4aa4f910f4 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/rules/sqale-linear-offset.xml @@ -0,0 +1,28 @@ + + + REUSABILITY + Reusability + + MODULARITY + Modularity + + repoKey + myRuleKey + + remediationFunction + linear_offset + + + remediationFactor + 2.0 + mn + + + offset + 15.0 + mn + + + + + \ No newline at end of file diff --git a/cxx-squid-bridge/src/test/resources/rules/sqale-linear.xml b/cxx-squid-bridge/src/test/resources/rules/sqale-linear.xml new file mode 100644 index 0000000000..a773b75ac1 --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/rules/sqale-linear.xml @@ -0,0 +1,23 @@ + + + REUSABILITY + Reusability + + MODULARITY + Modularity + + repoKey + myRuleKey + + remediationFunction + LINEAR + + + remediationFactor + 5 + mn + + + + + \ No newline at end of file diff --git a/cxx-squid-bridge/src/test/resources/rules/sqale-unknown-function.xml b/cxx-squid-bridge/src/test/resources/rules/sqale-unknown-function.xml new file mode 100644 index 0000000000..81cf23545a --- /dev/null +++ b/cxx-squid-bridge/src/test/resources/rules/sqale-unknown-function.xml @@ -0,0 +1,23 @@ + + + REUSABILITY + Reusability + + MODULARITY + Modularity + + myRepoKey + myRuleKey + + remediationFunction + XXX + + + offset + 10 + min + + + + + \ No newline at end of file diff --git a/cxx-squid/pom.xml b/cxx-squid/pom.xml index 9b4335a558..b91b45f56b 100644 --- a/cxx-squid/pom.xml +++ b/cxx-squid/pom.xml @@ -27,8 +27,9 @@ sslr-core - org.sonarsource.sslr-squid-bridge - sslr-squid-bridge + ${project.groupId} + cxx-squid-bridge + ${project.version} org.jdom diff --git a/cxx-squid/src/main/java/org/sonar/cxx/CxxAstScanner.java b/cxx-squid/src/main/java/org/sonar/cxx/CxxAstScanner.java index 5a6c5508ed..d4b06e059f 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/CxxAstScanner.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/CxxAstScanner.java @@ -22,13 +22,28 @@ import com.sonar.sslr.api.AstNode; import com.sonar.sslr.api.GenericTokenType; import com.sonar.sslr.api.Grammar; -import java.io.File; import static java.lang.Math.min; import java.util.Collection; +import org.sonar.api.batch.fs.InputFile; import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.config.CxxSquidConfiguration; import org.sonar.cxx.parser.CxxGrammarImpl; import org.sonar.cxx.parser.CxxParser; +import org.sonar.cxx.squidbridge.AstScanner; +import org.sonar.cxx.squidbridge.CommentAnalyser; +import org.sonar.cxx.squidbridge.SourceCodeBuilderVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitorContextImpl; +import org.sonar.cxx.squidbridge.api.SourceClass; +import org.sonar.cxx.squidbridge.api.SourceCode; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceFunction; +import org.sonar.cxx.squidbridge.api.SourceProject; +import org.sonar.cxx.squidbridge.indexer.QueryByType; +import org.sonar.cxx.squidbridge.metrics.CommentsVisitor; +import org.sonar.cxx.squidbridge.metrics.ComplexityVisitor; +import org.sonar.cxx.squidbridge.metrics.CounterVisitor; +import org.sonar.cxx.squidbridge.metrics.LinesVisitor; import org.sonar.cxx.visitors.CxxCharsetAwareVisitor; import org.sonar.cxx.visitors.CxxCognitiveComplexityVisitor; import org.sonar.cxx.visitors.CxxCpdVisitor; @@ -42,21 +57,6 @@ import org.sonar.cxx.visitors.CxxLinesOfCodeVisitor; import org.sonar.cxx.visitors.CxxParseErrorLoggerVisitor; import org.sonar.cxx.visitors.CxxPublicApiVisitor; -import org.sonar.squidbridge.AstScanner; -import org.sonar.squidbridge.CommentAnalyser; -import org.sonar.squidbridge.SourceCodeBuilderVisitor; -import org.sonar.squidbridge.SquidAstVisitor; -import org.sonar.squidbridge.SquidAstVisitorContextImpl; -import org.sonar.squidbridge.api.SourceClass; -import org.sonar.squidbridge.api.SourceCode; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.api.SourceFunction; -import org.sonar.squidbridge.api.SourceProject; -import org.sonar.squidbridge.indexer.QueryByType; -import org.sonar.squidbridge.metrics.CommentsVisitor; -import org.sonar.squidbridge.metrics.ComplexityVisitor; -import org.sonar.squidbridge.metrics.CounterVisitor; -import org.sonar.squidbridge.metrics.LinesVisitor; public final class CxxAstScanner { @@ -66,30 +66,30 @@ private CxxAstScanner() { /** * Helper method for testing checks without having to deploy them on a Sonar instance. * - * @param file is the file to be checked + * @param inputFile is the file to be checked * @param visitors AST checks and visitors to use * @return file checked with measures and issues */ @SafeVarargs - public static SourceFile scanSingleFile(File file, SquidAstVisitor... visitors) { - return scanSingleFileConfig(file, new CxxSquidConfiguration(), visitors); + public static SourceFile scanSingleInputFile(InputFile inputFile, SquidAstVisitor... visitors) { + return scanSingleInputFileConfig(inputFile, new CxxSquidConfiguration(), visitors); } /** * Helper method for scanning a single file * - * @param file is the file to be checked + * @param inputFile is the file to be checked * @param squidConfig the Squid configuration * @param visitors AST checks and visitors to use * @return file checked with measures and issues */ - public static SourceFile scanSingleFileConfig(File file, CxxSquidConfiguration squidConfig, - SquidAstVisitor... visitors) { - if (!file.isFile()) { - throw new IllegalArgumentException("File '" + file + "' not found."); + public static SourceFile scanSingleInputFileConfig(InputFile inputFile, CxxSquidConfiguration squidConfig, + SquidAstVisitor... visitors) { + if (!inputFile.isFile()) { + throw new IllegalArgumentException("File '" + inputFile.toString() + "' not found."); } AstScanner scanner = create(squidConfig, visitors); - scanner.scanFile(file); + scanner.scanInputFile(inputFile); Collection sources = scanner.getIndex().search(new QueryByType(SourceFile.class)); if (sources.size() != 1) { throw new IllegalStateException("Only one SourceFile was expected whereas " diff --git a/cxx-squid/src/main/java/org/sonar/cxx/api/CxxMetric.java b/cxx-squid/src/main/java/org/sonar/cxx/api/CxxMetric.java index 574d921a8d..89b71481fa 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/api/CxxMetric.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/api/CxxMetric.java @@ -20,8 +20,8 @@ package org.sonar.cxx.api; import javax.annotation.CheckForNull; -import org.sonar.squidbridge.measures.CalculatedMetricFormula; -import org.sonar.squidbridge.measures.MetricDef; +import org.sonar.cxx.squidbridge.measures.CalculatedMetricFormula; +import org.sonar.cxx.squidbridge.measures.MetricDef; public enum CxxMetric implements MetricDef { diff --git a/cxx-squid/src/main/java/org/sonar/cxx/config/CxxSquidConfiguration.java b/cxx-squid/src/main/java/org/sonar/cxx/config/CxxSquidConfiguration.java index ee88f93213..451f550683 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/config/CxxSquidConfiguration.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/config/CxxSquidConfiguration.java @@ -43,7 +43,7 @@ import org.sonar.api.utils.PathUtils; import org.sonar.api.utils.log.Logger; import org.sonar.api.utils.log.Loggers; -import org.sonar.squidbridge.api.SquidConfiguration; +import org.sonar.cxx.squidbridge.api.SquidConfiguration; /** * Database for compile options. diff --git a/cxx-squid/src/main/java/org/sonar/cxx/parser/CxxLexer.java b/cxx-squid/src/main/java/org/sonar/cxx/parser/CxxLexer.java index eed3021ead..62a2a9419e 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/parser/CxxLexer.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/parser/CxxLexer.java @@ -22,6 +22,7 @@ import com.sonar.sslr.api.Preprocessor; import com.sonar.sslr.impl.Lexer; import com.sonar.sslr.impl.channel.BlackHoleChannel; +import com.sonar.sslr.impl.channel.BomCharacterChannel; import com.sonar.sslr.impl.channel.IdentifierAndKeywordChannel; import com.sonar.sslr.impl.channel.PunctuatorChannel; import static com.sonar.sslr.impl.channel.RegexpChannelBuilder.ANY_CHAR; @@ -109,6 +110,7 @@ public static Lexer create(Charset charset, Preprocessor... preprocessors) { // C++ Standard, Section 2.13 "Operators and punctuators" .withChannel(new RightAngleBracketsChannel()) .withChannel(new PunctuatorChannel(CxxPunctuator.values())) + .withChannel(new BomCharacterChannel()) .withChannel(new UnknownCharacterChannel()); for (var preprocessor : preprocessors) { diff --git a/cxx-squid/src/main/java/org/sonar/cxx/parser/CxxParser.java b/cxx-squid/src/main/java/org/sonar/cxx/parser/CxxParser.java index 8b6af8bfcc..e9baddd471 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/parser/CxxParser.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/parser/CxxParser.java @@ -26,9 +26,9 @@ import org.sonar.cxx.config.CxxSquidConfiguration; import org.sonar.cxx.preprocessor.CxxPreprocessor; import org.sonar.cxx.preprocessor.JoinStringsPreprocessor; -import org.sonar.squidbridge.SquidAstVisitorContext; -import org.sonar.squidbridge.SquidAstVisitorContextImpl; -import org.sonar.squidbridge.api.SourceProject; +import org.sonar.cxx.squidbridge.SquidAstVisitorContext; +import org.sonar.cxx.squidbridge.SquidAstVisitorContextImpl; +import org.sonar.cxx.squidbridge.api.SourceProject; public final class CxxParser { diff --git a/cxx-squid/src/main/java/org/sonar/cxx/preprocessor/CppLexer.java b/cxx-squid/src/main/java/org/sonar/cxx/preprocessor/CppLexer.java index 06251c6714..e12e27fd9a 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/preprocessor/CppLexer.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/preprocessor/CppLexer.java @@ -20,6 +20,7 @@ package org.sonar.cxx.preprocessor; import com.sonar.sslr.impl.Lexer; +import com.sonar.sslr.impl.channel.BomCharacterChannel; import com.sonar.sslr.impl.channel.IdentifierAndKeywordChannel; import com.sonar.sslr.impl.channel.PunctuatorChannel; import static com.sonar.sslr.impl.channel.RegexpChannelBuilder.ANY_CHAR; @@ -32,10 +33,10 @@ import static com.sonar.sslr.impl.channel.RegexpChannelBuilder.regexp; import com.sonar.sslr.impl.channel.UnknownCharacterChannel; import java.nio.charset.Charset; -import org.sonar.cxx.parser.CxxTokenType; import org.sonar.cxx.channels.CharacterLiteralsChannel; import org.sonar.cxx.channels.KeywordChannel; import org.sonar.cxx.channels.StringLiteralsChannel; +import org.sonar.cxx.parser.CxxTokenType; public final class CppLexer { @@ -92,6 +93,7 @@ public static Lexer create(Charset charset) { //###.withChannel(new SpecialIdentifiers("import")) .withChannel(new IdentifierAndKeywordChannel(and("[a-zA-Z_]", o2n("\\w")), true)) .withChannel(new PunctuatorChannel(CppPunctuator.values())) + .withChannel(new BomCharacterChannel()) .withChannel(new UnknownCharacterChannel()); return builder.build(); diff --git a/cxx-squid/src/main/java/org/sonar/cxx/preprocessor/CxxPreprocessor.java b/cxx-squid/src/main/java/org/sonar/cxx/preprocessor/CxxPreprocessor.java index 9ec0b92c2a..f65363fe74 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/preprocessor/CxxPreprocessor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/preprocessor/CxxPreprocessor.java @@ -67,7 +67,7 @@ import static org.sonar.cxx.preprocessor.CppPunctuator.HASH; import static org.sonar.cxx.preprocessor.CppPunctuator.HASHHASH; import static org.sonar.cxx.preprocessor.CppPunctuator.LT; -import org.sonar.squidbridge.SquidAstVisitorContext; +import org.sonar.cxx.squidbridge.SquidAstVisitorContext; /** * Implements a C++ preprocessor according to '**A.12 Preprocessing directives [gram.cpp]**'. diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/AbstractCxxPublicApiVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/AbstractCxxPublicApiVisitor.java index e3806ccf7c..891878677e 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/AbstractCxxPublicApiVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/AbstractCxxPublicApiVisitor.java @@ -35,7 +35,7 @@ import static org.sonar.cxx.parser.CxxGrammarImpl.qualifiedId; import org.sonar.cxx.parser.CxxKeyword; import org.sonar.cxx.parser.CxxPunctuator; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.checks.SquidCheck; /** * Abstract visitor that visits public API items.
diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCognitiveComplexityVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCognitiveComplexityVisitor.java index 2edaf8f9c0..433128cdf2 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCognitiveComplexityVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCognitiveComplexityVisitor.java @@ -32,7 +32,7 @@ import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.parser.CxxPunctuator; import org.sonar.cxx.parser.CxxGrammarImpl; -import org.sonar.squidbridge.api.SourceCode; +import org.sonar.cxx.squidbridge.api.SourceCode; public class CxxCognitiveComplexityVisitor extends MultiLocatitionSquidCheck { diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCpdVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCpdVisitor.java index 715c8d4723..0b5a78e4aa 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCpdVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCpdVisitor.java @@ -31,7 +31,7 @@ import org.sonar.cxx.parser.CxxTokenType; import org.sonar.cxx.config.CxxSquidConfiguration; import org.sonar.cxx.parser.CxxGrammarImpl; -import org.sonar.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitor; public class CxxCpdVisitor extends SquidAstVisitor implements AstAndTokenVisitor { diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCyclomaticComplexityVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCyclomaticComplexityVisitor.java index 5535289552..544f18768a 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCyclomaticComplexityVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxCyclomaticComplexityVisitor.java @@ -25,15 +25,15 @@ import com.sonar.sslr.api.Token; import java.util.List; import javax.annotation.Nullable; -import org.sonar.squidbridge.SquidAstVisitor; -import org.sonar.squidbridge.SquidAstVisitorContext; -import org.sonar.squidbridge.metrics.ComplexityVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitorContext; +import org.sonar.cxx.squidbridge.metrics.ComplexityVisitor; /** - * Decorator for {@link org.sonar.squidbridge.metrics.ComplexityVisitor} in order to prevent visiting of generated + * Decorator for {@link org.sonar.cxx.squidbridge.metrics.ComplexityVisitor} in order to prevent visiting of generated * {@link com.sonar.sslr.api.AstNode}s * - * Inheritance is not possible, since the class {@link org.sonar.squidbridge.metrics.ComplexityVisitor} is marked as + * Inheritance is not possible, since the class {@link org.sonar.cxx.squidbridge.metrics.ComplexityVisitor} is marked as * final * * @param diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFileLinesVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFileLinesVisitor.java index dda81e1370..ae3b94dbb2 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFileLinesVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFileLinesVisitor.java @@ -32,7 +32,7 @@ import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.parser.CxxPunctuator; import org.sonar.cxx.parser.CxxGrammarImpl; -import org.sonar.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitor; /** * Visitor that computes {@link CoreMetrics#NCLOC_DATA_KEY} and {@link CoreMetrics#EXECUTABLE_LINES_DATA} metrics used diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFileVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFileVisitor.java index 0da477b2df..b4e3653050 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFileVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFileVisitor.java @@ -22,7 +22,7 @@ import com.sonar.sslr.api.AstNode; import com.sonar.sslr.api.Grammar; import org.sonar.cxx.parser.CxxParser; -import org.sonar.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitor; public class CxxFileVisitor extends SquidAstVisitor { diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFunctionComplexityVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFunctionComplexityVisitor.java index 8592b2ba50..bd4863328e 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFunctionComplexityVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFunctionComplexityVisitor.java @@ -26,10 +26,10 @@ import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.config.CxxSquidConfiguration; import org.sonar.cxx.parser.CxxGrammarImpl; -import org.sonar.squidbridge.SquidAstVisitor; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.api.SourceFunction; -import org.sonar.squidbridge.checks.ChecksHelper; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceFunction; +import org.sonar.cxx.squidbridge.checks.ChecksHelper; public class CxxFunctionComplexityVisitor extends SquidAstVisitor { diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFunctionSizeVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFunctionSizeVisitor.java index 9e767a9d86..a04c2d7972 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFunctionSizeVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxFunctionSizeVisitor.java @@ -26,9 +26,9 @@ import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.config.CxxSquidConfiguration; import org.sonar.cxx.parser.CxxGrammarImpl; -import org.sonar.squidbridge.SquidAstVisitor; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.api.SourceFunction; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceFunction; public class CxxFunctionSizeVisitor extends SquidAstVisitor { diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxHighlighterVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxHighlighterVisitor.java index 49cc1f9a74..1651b2ffba 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxHighlighterVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxHighlighterVisitor.java @@ -33,7 +33,7 @@ import org.sonar.cxx.parser.CxxKeyword; import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.parser.CxxTokenType; -import org.sonar.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitor; public class CxxHighlighterVisitor extends SquidAstVisitor implements AstAndTokenVisitor { diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxLinesOfCodeInFunctionBodyVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxLinesOfCodeInFunctionBodyVisitor.java index 986e2cb535..935ac9e59d 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxLinesOfCodeInFunctionBodyVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxLinesOfCodeInFunctionBodyVisitor.java @@ -26,7 +26,7 @@ import org.sonar.cxx.preprocessor.CppPunctuator; import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.parser.CxxGrammarImpl; -import org.sonar.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitor; /** * Visitor that computes the NCLOCs in function body, leading and trailing {} do not count diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxLinesOfCodeVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxLinesOfCodeVisitor.java index 73bcf1b31a..d98208a4c8 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxLinesOfCodeVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxLinesOfCodeVisitor.java @@ -27,9 +27,9 @@ import com.sonar.sslr.api.Trivia; import java.util.regex.Pattern; import org.sonar.cxx.api.CxxMetric; -import org.sonar.squidbridge.SquidAstVisitor; -import org.sonar.squidbridge.api.SourceCode; -import org.sonar.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.api.SourceCode; +import org.sonar.cxx.squidbridge.api.SourceFile; /** * Visitor that computes the number of lines of code of a file. diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxParseErrorLoggerVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxParseErrorLoggerVisitor.java index 97715f90c2..8ef0473b71 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxParseErrorLoggerVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxParseErrorLoggerVisitor.java @@ -28,7 +28,7 @@ import org.sonar.api.utils.log.Loggers; import org.sonar.cxx.parser.CxxPunctuator; import org.sonar.cxx.parser.CxxGrammarImpl; -import org.sonar.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitor; public class CxxParseErrorLoggerVisitor extends SquidAstVisitor { diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxPublicApiVisitor.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxPublicApiVisitor.java index 02fef93d5c..325a08993b 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxPublicApiVisitor.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/CxxPublicApiVisitor.java @@ -30,7 +30,7 @@ import org.sonar.api.utils.log.Loggers; import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.config.CxxSquidConfiguration; -import org.sonar.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceFile; /** * Visitor that counts documented and undocumented API items.
diff --git a/cxx-squid/src/main/java/org/sonar/cxx/visitors/MultiLocatitionSquidCheck.java b/cxx-squid/src/main/java/org/sonar/cxx/visitors/MultiLocatitionSquidCheck.java index 4f89cfe9ca..de03e0af3d 100644 --- a/cxx-squid/src/main/java/org/sonar/cxx/visitors/MultiLocatitionSquidCheck.java +++ b/cxx-squid/src/main/java/org/sonar/cxx/visitors/MultiLocatitionSquidCheck.java @@ -26,17 +26,17 @@ import javax.annotation.Nullable; import org.sonar.api.utils.AnnotationUtils; import org.sonar.cxx.utils.CxxReportIssue; -import org.sonar.squidbridge.SquidAstVisitorContext; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.checks.SquidCheck; -import org.sonar.squidbridge.measures.CalculatedMetricFormula; -import org.sonar.squidbridge.measures.MetricDef; +import org.sonar.cxx.squidbridge.SquidAstVisitorContext; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.measures.CalculatedMetricFormula; +import org.sonar.cxx.squidbridge.measures.MetricDef; /** * Derivation of {@link SquidCheck}, which can create issues with multiple locations (1 primary location, arbitrary * number of secondary locations * - * See also org.sonar.squidbridge.SquidAstVisitorContext.createLineViolation + * See also org.sonar.cxx.squidbridge.SquidAstVisitorContext.createLineViolation * * @param */ diff --git a/cxx-squid/src/test/java/org/sonar/cxx/CxxAstScannerTest.java b/cxx-squid/src/test/java/org/sonar/cxx/CxxAstScannerTest.java index b2514f28dc..f750fe8dd5 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/CxxAstScannerTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/CxxAstScannerTest.java @@ -19,7 +19,6 @@ */ package org.sonar.cxx; -import org.sonar.cxx.config.CxxSquidConfiguration; import com.sonar.sslr.api.Grammar; import java.io.File; import java.io.IOException; @@ -30,18 +29,19 @@ import org.assertj.core.api.SoftAssertions; import org.junit.Test; import org.sonar.cxx.api.CxxMetric; -import org.sonar.squidbridge.AstScanner; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.api.SourceProject; -import org.sonar.squidbridge.indexer.QueryByType; +import org.sonar.cxx.config.CxxSquidConfiguration; +import org.sonar.cxx.squidbridge.AstScanner; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceProject; +import org.sonar.cxx.squidbridge.indexer.QueryByType; public class CxxAstScannerTest { @Test public void files() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/trivial.cc", ".", ""); - CxxFileTesterHelper.AddFileToContext(tester, "src/test/resources/metrics/trivial.cc", ""); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/trivial.cc", ".", ""); + CxxFileTesterHelper.add(tester, "src/test/resources/metrics/trivial.cc", ""); AstScanner scanner = CxxAstScanner.create(new CxxSquidConfiguration()); scanner.scanFiles(new ArrayList<>(Arrays.asList( @@ -55,8 +55,8 @@ public void files() throws UnsupportedEncodingException, IOException { @Test public void comments() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/comments.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/comments.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); var softly = new SoftAssertions(); softly.assertThat(file.getInt(CxxMetric.COMMENT_LINES)).isEqualTo(6); softly.assertThat(file.getNoSonarTagLines()).contains(8).hasSize(1); @@ -65,75 +65,72 @@ public void comments() throws UnsupportedEncodingException, IOException { @Test public void lines() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/classes.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/classes.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); assertThat(file.getInt(CxxMetric.LINES)).isEqualTo(7); } @Test public void lines_of_code() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/classes.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/classes.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); assertThat(file.getInt(CxxMetric.LINES_OF_CODE)).isEqualTo(5); } @Test public void statements() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/statements.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/statements.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); assertThat(file.getInt(CxxMetric.STATEMENTS)).isEqualTo(4); } @Test public void functions() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/functions.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/functions.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); assertThat(file.getInt(CxxMetric.FUNCTIONS)).isEqualTo(2); } @Test public void classes() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/classes.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/classes.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); assertThat(file.getInt(CxxMetric.CLASSES)).isEqualTo(2); } @Test public void complexity() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/complexity.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/complexity.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); assertThat(file.getInt(CxxMetric.COMPLEXITY)).isEqualTo(14); } @Test public void complexity_alternative() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester( - "src/test/resources/metrics/complexity_alternative.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/complexity_alternative.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); assertThat(file.getInt(CxxMetric.COMPLEXITY)).isEqualTo(14); } @Test public void complexity_macro() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper - .CreateCxxFileTester("src/test/resources/metrics/complexity_macro.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/complexity_macro.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); assertThat(file.getInt(CxxMetric.COMPLEXITY)).isEqualTo(1); } @Test public void error_recovery_declaration() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester( - "src/test/resources/parser/bad/error_recovery_declaration.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/parser/bad/error_recovery_declaration.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); assertThat(file.getInt(CxxMetric.FUNCTIONS)).isEqualTo(2); } @Test public void nosonar_comments() throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/nosonar.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/nosonar.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); assertThat(file.getNoSonarTagLines()).containsOnlyElementsOf(Arrays.asList(3, 6, 9, 11)); } diff --git a/cxx-squid/src/test/java/org/sonar/cxx/CxxFileTester.java b/cxx-squid/src/test/java/org/sonar/cxx/CxxFileTester.java index d54dbecc59..65a82c1d9b 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/CxxFileTester.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/CxxFileTester.java @@ -19,7 +19,6 @@ */ package org.sonar.cxx; -import java.io.File; import org.sonar.api.batch.fs.InputFile; import org.sonar.api.batch.sensor.internal.SensorContextTester; @@ -28,8 +27,8 @@ public class CxxFileTester { public InputFile cxxFile; public SensorContextTester context; - public File asFile() { - return new File(cxxFile.uri().getPath()); + public InputFile asInputFile() { + return cxxFile; } } diff --git a/cxx-squid/src/test/java/org/sonar/cxx/CxxFileTesterHelper.java b/cxx-squid/src/test/java/org/sonar/cxx/CxxFileTesterHelper.java index c0448bb10f..5727fabb60 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/CxxFileTesterHelper.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/CxxFileTesterHelper.java @@ -20,39 +20,66 @@ package org.sonar.cxx; import java.io.File; +import java.io.FileInputStream; import java.io.IOException; import java.io.UnsupportedEncodingException; +import java.nio.charset.Charset; +import java.nio.file.Paths; +import org.apache.commons.io.ByteOrderMark; +import org.apache.commons.io.input.BOMInputStream; +import org.sonar.api.batch.fs.internal.DefaultInputFile; import org.sonar.api.batch.fs.internal.TestInputFileBuilder; import org.sonar.api.batch.sensor.internal.SensorContextTester; -/** - * - * @author jocs - */ public class CxxFileTesterHelper { - public static CxxFileTester CreateCxxFileTester(String fileName, String basePath, String module) throws - UnsupportedEncodingException, IOException { - CxxFileTester tester = new CxxFileTester(); - tester.context = SensorContextTester.create(new File(basePath)); + private CxxFileTesterHelper() { + // utility class + } - tester.context.fileSystem().add(TestInputFileBuilder.create(module, fileName).build()); - tester.cxxFile = tester.context.fileSystem().inputFile(tester.context.fileSystem().predicates().hasPath( - fileName)); + public static CxxFileTester create(String fileName, String basePath, String moduleKey) + throws UnsupportedEncodingException, IOException { + var tester = new CxxFileTester(); + + tester.context = SensorContextTester.create(new File(basePath)); + tester.cxxFile = createInputFile(moduleKey, fileName, basePath, Charset.defaultCharset()); + tester.context.fileSystem().add(tester.cxxFile); return tester; } - public static CxxFileTester AddFileToContext(CxxFileTester tester, String fileName, String module) throws - UnsupportedEncodingException, IOException { - tester.context.fileSystem().add(TestInputFileBuilder.create(module, fileName).build()); - tester.cxxFile = tester.context.fileSystem().inputFile(tester.context.fileSystem().predicates().hasPath( - fileName)); + public static CxxFileTester add(CxxFileTester tester, String fileName, String moduleKey) + throws UnsupportedEncodingException, IOException { + + tester.cxxFile = createInputFile(moduleKey, fileName, "", Charset.defaultCharset()); + tester.context.fileSystem().add(tester.cxxFile); + return tester; } - private CxxFileTesterHelper() { - // utility class + private static DefaultInputFile createInputFile(String moduleKey, String fileName, String basePath, Charset charset) + throws IOException { + TestInputFileBuilder fb = TestInputFileBuilder.create(moduleKey, fileName); + + fb.setCharset(charset); + fb.setProjectBaseDir(Paths.get(basePath)); + fb.setContents(getSourceCode(Paths.get(basePath, fileName).toFile(), charset)); + + return fb.build(); + } + + private static String getSourceCode(File filename, Charset defaultCharset) throws IOException { + try ( BOMInputStream bomInputStream = new BOMInputStream(new FileInputStream(filename), + ByteOrderMark.UTF_8, + ByteOrderMark.UTF_16LE, + ByteOrderMark.UTF_16BE, + ByteOrderMark.UTF_32LE, + ByteOrderMark.UTF_32BE)) { + ByteOrderMark bom = bomInputStream.getBOM(); + Charset charset = bom != null ? Charset.forName(bom.getCharsetName()) : defaultCharset; + byte[] bytes = bomInputStream.readAllBytes(); + return new String(bytes, charset); + } } } diff --git a/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerIncludeTest.java b/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerIncludeTest.java index f1efa905fb..6006aeae1c 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerIncludeTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerIncludeTest.java @@ -35,7 +35,7 @@ import org.sonar.cxx.preprocessor.CxxPreprocessor; import org.sonar.cxx.preprocessor.JoinStringsPreprocessor; import org.sonar.cxx.utils.TestUtils; -import org.sonar.squidbridge.SquidAstVisitorContext; +import org.sonar.cxx.squidbridge.SquidAstVisitorContext; public class CxxLexerIncludeTest { diff --git a/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerTest.java b/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerTest.java index 7a5c3a0636..656c0e7da3 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerTest.java @@ -39,7 +39,7 @@ import static org.sonar.cxx.lexer.LexerAssert.assertThat; import org.sonar.cxx.preprocessor.CxxPreprocessor; import org.sonar.cxx.preprocessor.JoinStringsPreprocessor; -import org.sonar.squidbridge.SquidAstVisitorContext; +import org.sonar.cxx.squidbridge.SquidAstVisitorContext; public class CxxLexerTest { diff --git a/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerWithPreprocessingTest.java b/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerWithPreprocessingTest.java index 1ed77ac83f..63be018af4 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerWithPreprocessingTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/lexer/CxxLexerWithPreprocessingTest.java @@ -46,7 +46,7 @@ import org.sonar.cxx.preprocessor.CxxPreprocessor; import org.sonar.cxx.preprocessor.JoinStringsPreprocessor; import org.sonar.cxx.preprocessor.SourceCodeProvider; -import org.sonar.squidbridge.SquidAstVisitorContext; +import org.sonar.cxx.squidbridge.SquidAstVisitorContext; public class CxxLexerWithPreprocessingTest { diff --git a/cxx-squid/src/test/java/org/sonar/cxx/parser/CxxParserTest.java b/cxx-squid/src/test/java/org/sonar/cxx/parser/CxxParserTest.java index e0eda9112d..29215eacec 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/parser/CxxParserTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/parser/CxxParserTest.java @@ -36,7 +36,7 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; import org.sonar.cxx.config.CxxSquidConfiguration; -import org.sonar.squidbridge.SquidAstVisitorContext; +import org.sonar.cxx.squidbridge.SquidAstVisitorContext; public class CxxParserTest { diff --git a/cxx-squid/src/test/java/org/sonar/cxx/parser/ParserBaseTestHelper.java b/cxx-squid/src/test/java/org/sonar/cxx/parser/ParserBaseTestHelper.java index 4deb51ba47..4de0d5f05d 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/parser/ParserBaseTestHelper.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/parser/ParserBaseTestHelper.java @@ -29,7 +29,7 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; import org.sonar.cxx.config.CxxSquidConfiguration; -import org.sonar.squidbridge.SquidAstVisitorContextImpl; +import org.sonar.cxx.squidbridge.SquidAstVisitorContextImpl; import org.sonar.sslr.grammar.GrammarRuleKey; import org.sonar.sslr.tests.ParserAssert; diff --git a/cxx-squid/src/test/java/org/sonar/cxx/preprocessor/ExpressionEvaluatorTest.java b/cxx-squid/src/test/java/org/sonar/cxx/preprocessor/ExpressionEvaluatorTest.java index d9afff4dc6..128f3eb376 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/preprocessor/ExpressionEvaluatorTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/preprocessor/ExpressionEvaluatorTest.java @@ -31,7 +31,7 @@ import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -import org.sonar.squidbridge.SquidAstVisitorContext; +import org.sonar.cxx.squidbridge.SquidAstVisitorContext; public class ExpressionEvaluatorTest { diff --git a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxCognitiveComplexityVisitorTest.java b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxCognitiveComplexityVisitorTest.java index 345c266288..42118d30c5 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxCognitiveComplexityVisitorTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxCognitiveComplexityVisitorTest.java @@ -27,7 +27,7 @@ import org.sonar.cxx.CxxFileTester; import org.sonar.cxx.CxxFileTesterHelper; import org.sonar.cxx.api.CxxMetric; -import org.sonar.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceFile; public class CxxCognitiveComplexityVisitorTest { @@ -152,8 +152,8 @@ public void to_regexp() throws UnsupportedEncodingException, IOException { } private int testFile(String fileName) throws UnsupportedEncodingException, IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester(fileName, ".", ""); - SourceFile sourceFile = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create(fileName, ".", ""); + SourceFile sourceFile = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); return (sourceFile.getInt(CxxMetric.COGNITIVE_COMPLEXITY)); } diff --git a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxCpdVisitorTest.java b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxCpdVisitorTest.java index e5199c81ef..8f989fd43f 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxCpdVisitorTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxCpdVisitorTest.java @@ -19,7 +19,6 @@ */ package org.sonar.cxx.visitors; -import java.io.File; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.util.List; @@ -27,10 +26,10 @@ import org.junit.Before; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; +import org.sonar.cxx.CxxFileTesterHelper; import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.config.CxxSquidConfiguration; -import org.sonar.cxx.utils.TestUtils; -import org.sonar.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceFile; public class CxxCpdVisitorTest { @@ -38,15 +37,14 @@ public class CxxCpdVisitorTest { @Before public void scanFile() throws UnsupportedEncodingException, IOException { - File baseDir = TestUtils.loadResource("/visitors"); - var file = new File(baseDir, "cpd.cc"); + var tester = CxxFileTesterHelper.create("src/test/resources/visitors/cpd.cc", ".", ""); var squidConfig = new CxxSquidConfiguration(); - squidConfig.add(CxxSquidConfiguration.SONAR_PROJECT_PROPERTIES, CxxSquidConfiguration.CPD_IGNORE_LITERALS, "true"); + squidConfig + .add(CxxSquidConfiguration.SONAR_PROJECT_PROPERTIES, CxxSquidConfiguration.CPD_IGNORE_LITERALS, "true"); squidConfig .add(CxxSquidConfiguration.SONAR_PROJECT_PROPERTIES, CxxSquidConfiguration.CPD_IGNORE_IDENTIFIERS, "true"); - var cpdVisitor = new CxxCpdVisitor(squidConfig); - sourceFile = CxxAstScanner.scanSingleFile(file, cpdVisitor); + sourceFile = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), new CxxCpdVisitor(squidConfig)); } @Test diff --git a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFileLinesVisitorTest.java b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFileLinesVisitorTest.java index c9a3ccfe40..c629a01112 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFileLinesVisitorTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFileLinesVisitorTest.java @@ -19,7 +19,6 @@ */ package org.sonar.cxx.visitors; -import java.io.File; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.util.HashSet; @@ -32,21 +31,18 @@ import org.junit.Before; import org.junit.Test; import org.sonar.cxx.CxxAstScanner; +import org.sonar.cxx.CxxFileTesterHelper; import org.sonar.cxx.api.CxxMetric; -import org.sonar.cxx.utils.TestUtils; -import org.sonar.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceFile; public class CxxFileLinesVisitorTest { private SourceFile sourceFile; @Before - public void setUp() { - - File baseDir = TestUtils.loadResource("/visitors"); - var file = new File(baseDir, "ncloc.cc"); - var fileLinesVisitor = new CxxFileLinesVisitor(); - sourceFile = CxxAstScanner.scanSingleFile(file, fileLinesVisitor); + public void setUp() throws IOException { + var tester = CxxFileTesterHelper.create("src/test/resources/visitors/ncloc.cc", ".", ""); + sourceFile = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), new CxxFileLinesVisitor()); } @Test diff --git a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFunctionComplexityVisitorTest.java b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFunctionComplexityVisitorTest.java index 01e56ce881..28df559eff 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFunctionComplexityVisitorTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFunctionComplexityVisitorTest.java @@ -27,7 +27,7 @@ import org.sonar.cxx.CxxFileTesterHelper; import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.config.CxxSquidConfiguration; -import org.sonar.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceFile; public class CxxFunctionComplexityVisitorTest { @@ -37,9 +37,9 @@ public void testPublishMeasuresForFile() throws IOException { CxxSquidConfiguration squidConfig = new CxxSquidConfiguration(); squidConfig.add(CxxSquidConfiguration.SONAR_PROJECT_PROPERTIES, CxxSquidConfiguration.FUNCTION_COMPLEXITY_THRESHOLD, "5"); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/FunctionComplexity.cc", + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/FunctionComplexity.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig); var softly = new SoftAssertions(); softly.assertThat(file.getInt(CxxMetric.COMPLEX_FUNCTIONS)).isEqualTo(4); @@ -50,8 +50,8 @@ public void testPublishMeasuresForFile() throws IOException { @Test public void testPublishMeasuresForEmptyFile() throws IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/EmptyFile.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/EmptyFile.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); var softly = new SoftAssertions(); softly.assertThat(file.getInt(CxxMetric.COMPLEX_FUNCTIONS)).isZero(); diff --git a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFunctionSizeVisitorTest.java b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFunctionSizeVisitorTest.java index a93a5fd390..3c067287e8 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFunctionSizeVisitorTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxFunctionSizeVisitorTest.java @@ -27,7 +27,7 @@ import org.sonar.cxx.CxxFileTesterHelper; import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.config.CxxSquidConfiguration; -import org.sonar.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceFile; public class CxxFunctionSizeVisitorTest { @@ -37,9 +37,9 @@ public void testPublishMeasuresForFile() throws IOException { CxxSquidConfiguration squidConfig = new CxxSquidConfiguration(); squidConfig.add(CxxSquidConfiguration.SONAR_PROJECT_PROPERTIES, CxxSquidConfiguration.FUNCTION_SIZE_THRESHOLD, "5"); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/FunctionComplexity.cc", + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/FunctionComplexity.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig); var softly = new SoftAssertions(); softly.assertThat(file.getInt(CxxMetric.BIG_FUNCTIONS)).isEqualTo(4); @@ -50,8 +50,8 @@ public void testPublishMeasuresForFile() throws IOException { @Test public void testPublishMeasuresForEmptyFile() throws IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/EmptyFile.cc", ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile()); + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/EmptyFile.cc", ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile()); var softly = new SoftAssertions(); softly.assertThat(file.getInt(CxxMetric.BIG_FUNCTIONS)).isZero(); diff --git a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxParseErrorLoggerVisitorTest.java b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxParseErrorLoggerVisitorTest.java index 6ab0e81aea..cfccb09593 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxParseErrorLoggerVisitorTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxParseErrorLoggerVisitorTest.java @@ -19,17 +19,14 @@ */ package org.sonar.cxx.visitors; -import java.io.File; import static org.assertj.core.api.Assertions.assertThat; import org.junit.Before; import org.junit.Rule; import org.junit.Test; -import org.sonar.api.batch.fs.InputFile; -import org.sonar.api.batch.fs.internal.TestInputFileBuilder; -import org.sonar.api.batch.sensor.internal.SensorContextTester; import org.sonar.api.utils.log.LogTester; import org.sonar.api.utils.log.LoggerLevel; import org.sonar.cxx.CxxAstScanner; +import org.sonar.cxx.CxxFileTesterHelper; public class CxxParseErrorLoggerVisitorTest { @@ -37,14 +34,10 @@ public class CxxParseErrorLoggerVisitorTest { public LogTester logTester = new LogTester(); @Before - public void scanFile() { - String dir = "src/test/resources/visitors"; - InputFile inputFile = TestInputFileBuilder.create("", dir + "/syntaxerror.cc").build(); - SensorContextTester context = SensorContextTester.create(new File(dir)); - context.fileSystem().add(inputFile); - + public void scanFile() throws Exception { + var tester = CxxFileTesterHelper.create("src/test/resources/visitors/syntaxerror.cc", ".", ""); logTester.setLevel(LoggerLevel.DEBUG); - CxxAstScanner.scanSingleFile(new File(inputFile.uri().getPath())); + CxxAstScanner.scanSingleInputFile(tester.asInputFile()); } @Test diff --git a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxPublicApiVisitorTest.java b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxPublicApiVisitorTest.java index 7f5aa7f153..fad71c3c12 100644 --- a/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxPublicApiVisitorTest.java +++ b/cxx-squid/src/test/java/org/sonar/cxx/visitors/CxxPublicApiVisitorTest.java @@ -38,7 +38,7 @@ import org.sonar.cxx.CxxFileTesterHelper; import org.sonar.cxx.api.CxxMetric; import org.sonar.cxx.config.CxxSquidConfiguration; -import org.sonar.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.api.SourceFile; public class CxxPublicApiVisitorTest { @@ -54,13 +54,13 @@ private static String getFileExtension(String fileName) { @Test public void test_no_matching_suffix() throws IOException { - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester("src/test/resources/metrics/doxygen_example.h", ".", + var tester = CxxFileTesterHelper.create("src/test/resources/metrics/doxygen_example.h", ".", ""); CxxSquidConfiguration squidConfig = new CxxSquidConfiguration(); squidConfig.add(CxxSquidConfiguration.SONAR_PROJECT_PROPERTIES, CxxSquidConfiguration.API_FILE_SUFFIXES, new String[]{".hpp"}); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig); assertThat(file.getInt(CxxMetric.PUBLIC_API)).isZero(); assertThat(file.getInt(CxxMetric.PUBLIC_UNDOCUMENTED_API)).isZero(); @@ -107,8 +107,8 @@ public void public_api() throws UnsupportedEncodingException, IOException { String fileNme = "src/test/resources/metrics/public_api.h"; TestPublicApiVisitor visitor = new TestPublicApiVisitor(fileNme, true); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester(fileNme, ".", ""); - SourceFile file = CxxAstScanner.scanSingleFile(tester.asFile(), visitor); + var tester = CxxFileTesterHelper.create(fileNme, ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFile(tester.asInputFile(), visitor); var expectedIdCommentMap = new HashMap(); @@ -213,8 +213,8 @@ private Tuple testFile(String fileName) squidConfig.add(CxxSquidConfiguration.SONAR_PROJECT_PROPERTIES, CxxSquidConfiguration.API_FILE_SUFFIXES, new String[]{getFileExtension(fileName)}); - CxxFileTester tester = CxxFileTesterHelper.CreateCxxFileTester(fileName, ".", ""); - SourceFile file = CxxAstScanner.scanSingleFileConfig(tester.asFile(), squidConfig); + var tester = CxxFileTesterHelper.create(fileName, ".", ""); + SourceFile file = CxxAstScanner.scanSingleInputFileConfig(tester.asInputFile(), squidConfig); LOG.debug("#API: {} UNDOC: {}", file.getInt(CxxMetric.PUBLIC_API), file.getInt(CxxMetric.PUBLIC_UNDOCUMENTED_API)); diff --git a/sslr-cxx-toolkit/pom.xml b/cxx-sslr-toolkit/pom.xml similarity index 98% rename from sslr-cxx-toolkit/pom.xml rename to cxx-sslr-toolkit/pom.xml index 2ad9d1d185..9afea03aa7 100644 --- a/sslr-cxx-toolkit/pom.xml +++ b/cxx-sslr-toolkit/pom.xml @@ -7,7 +7,7 @@ 2.0.2-SNAPSHOT - sslr-cxx-toolkit + cxx-sslr-toolkit Cxx :: SSLR Toolkit diff --git a/sslr-cxx-toolkit/src/main/java/org/sonar/cxx/toolkit/CxxConfigurationModel.java b/cxx-sslr-toolkit/src/main/java/org/sonar/cxx/toolkit/CxxConfigurationModel.java similarity index 98% rename from sslr-cxx-toolkit/src/main/java/org/sonar/cxx/toolkit/CxxConfigurationModel.java rename to cxx-sslr-toolkit/src/main/java/org/sonar/cxx/toolkit/CxxConfigurationModel.java index 2e42241f57..8a422cf6a0 100644 --- a/sslr-cxx-toolkit/src/main/java/org/sonar/cxx/toolkit/CxxConfigurationModel.java +++ b/cxx-sslr-toolkit/src/main/java/org/sonar/cxx/toolkit/CxxConfigurationModel.java @@ -39,8 +39,8 @@ import org.sonar.cxx.config.CxxSquidConfiguration; import org.sonar.cxx.parser.CxxKeyword; import org.sonar.cxx.parser.CxxParser; -import org.sonar.squidbridge.SquidAstVisitorContextImpl; -import org.sonar.squidbridge.api.SourceProject; +import org.sonar.cxx.squidbridge.SquidAstVisitorContextImpl; +import org.sonar.cxx.squidbridge.api.SourceProject; import org.sonar.sslr.toolkit.AbstractConfigurationModel; import org.sonar.sslr.toolkit.ConfigurationProperty; import org.sonar.sslr.toolkit.Validators; diff --git a/sslr-cxx-toolkit/src/main/java/org/sonar/cxx/toolkit/CxxToolkit.java b/cxx-sslr-toolkit/src/main/java/org/sonar/cxx/toolkit/CxxToolkit.java similarity index 100% rename from sslr-cxx-toolkit/src/main/java/org/sonar/cxx/toolkit/CxxToolkit.java rename to cxx-sslr-toolkit/src/main/java/org/sonar/cxx/toolkit/CxxToolkit.java diff --git a/sslr-cxx-toolkit/src/main/java/org/sonar/cxx/toolkit/package-info.java b/cxx-sslr-toolkit/src/main/java/org/sonar/cxx/toolkit/package-info.java similarity index 100% rename from sslr-cxx-toolkit/src/main/java/org/sonar/cxx/toolkit/package-info.java rename to cxx-sslr-toolkit/src/main/java/org/sonar/cxx/toolkit/package-info.java diff --git a/integration-tests/features/regex.feature b/integration-tests/features/regex.feature index 58cb963e2f..a04d494161 100644 --- a/integration-tests/features/regex.feature +++ b/integration-tests/features/regex.feature @@ -32,7 +32,7 @@ Feature: Regex """ And the following metrics have following values: | metric | value | - | ncloc | 6 | + | ncloc | 3 | | lines | 18 | | files | 3 | | violations | 0 | @@ -49,7 +49,7 @@ Feature: Regex """ And the following metrics have following values: | metric | value | - | ncloc | 23 | + | ncloc | 3 | | lines | 18 | | files | 3 | | violations | 0 | diff --git a/integration-tests/features/smoketest.feature b/integration-tests/features/smoketest.feature index c89e24c553..940e03d997 100644 --- a/integration-tests/features/smoketest.feature +++ b/integration-tests/features/smoketest.feature @@ -3,7 +3,7 @@ Feature: Smoketests This is for running smoketests using somewhat more complex test data. - Scenario: Smoketest + Scenario: Smoketest UTF-8 (without BOM) Given the project "smoketest_project" And rule "cppcheck:unusedVariable" is activated And rule "cppcheck:unreadVariable" is activated @@ -68,6 +68,136 @@ Feature: Smoketests | security_hotspots | 0 | + Scenario: Smoketest UTF-8 (with BOM) + Given the project "smoketest_project_utf8_bom" + And rule "cppcheck:unusedVariable" is activated + And rule "cppcheck:unreadVariable" is activated + And rule "cppcheck:deallocDealloc" is activated + And rule "cppcheck:doubleFree" is activated + And rule "cppcheck:uninitvar" is activated + And rule "cppcheck:unusedFunction" is activated + And rule "cppcheck:missingInclude" is activated + When I run sonar-scanner with "-X" + Then the analysis finishes successfully + And the analysis in server has completed + And the analysis log contains no error/warning messages except those matching: + """ + .*WARN.*Unable to get a valid mac address, will use a dummy address + .*WARN.*cannot find the sources for '#include ' + .*WARN.*cannot find the sources for '#include ' + .*WARN.*Cannot find the file '.*component_XXX.cc', skipping + .*WARN.*Cannot find a report for '.*' + """ + And the following metrics have following values: + | metric | value | + | ncloc | 56 | + | lines | 151 | + | statements | 36 | + | classes | 1 | + | files | 8 | + | directories | None | + | functions | 5 | + | comment_lines_density | 30 | + | comment_lines | 24 | + | duplicated_lines_density | 55.6 | + | duplicated_lines | 84 | + | duplicated_blocks | 2 | + | duplicated_files | 2 | + | complexity | 7 | + | cognitive_complexity | 2 | + | file_complexity | 0.9 | + | violations | 12 | + | lines_to_cover | 31 | + | coverage | 53.8 | + | line_coverage | 54.8 | + | branch_coverage | 50 | + | uncovered_conditions | 4 | + | uncovered_lines | 14 | + | tests | 5 | + | test_failures | 2 | + | test_errors | 0 | + | skipped_tests | 1 | + | test_execution_time | 159 | + | test_success_density | None | + | false_positive_issues | 0 | + | open_issues | 12 | + | confirmed_issues | 0 | + | reopened_issues | 0 | + | code_smells | 6 | + | sqale_index | 30 | + | sqale_debt_ratio | 1.8 | + | bugs | 6 | + | reliability_remediation_effort | 30 | + | vulnerabilities | 0 | + | security_remediation_effort | 0 | + | security_hotspots | 0 | + + + Scenario: Smoketest UTF-16LE (with BOM) + Given the project "smoketest_project_utf16" + And rule "cppcheck:unusedVariable" is activated + And rule "cppcheck:unreadVariable" is activated + And rule "cppcheck:deallocDealloc" is activated + And rule "cppcheck:doubleFree" is activated + And rule "cppcheck:uninitvar" is activated + And rule "cppcheck:unusedFunction" is activated + And rule "cppcheck:missingInclude" is activated + When I run sonar-scanner with "-X" + Then the analysis finishes successfully + And the analysis in server has completed + And the analysis log contains no error/warning messages except those matching: + """ + .*WARN.*Unable to get a valid mac address, will use a dummy address + .*WARN.*cannot find the sources for '#include ' + .*WARN.*cannot find the sources for '#include ' + .*WARN.*Cannot find the file '.*component_XXX.cc', skipping + .*WARN.*Cannot find a report for '.*' + """ + And the following metrics have following values: + | metric | value | + | ncloc | 56 | + | lines | 151 | + | statements | 36 | + | classes | 1 | + | files | 8 | + | directories | None | + | functions | 5 | + | comment_lines_density | 30 | + | comment_lines | 24 | + | duplicated_lines_density | 55.6 | + | duplicated_lines | 84 | + | duplicated_blocks | 2 | + | duplicated_files | 2 | + | complexity | 7 | + | cognitive_complexity | 2 | + | file_complexity | 0.9 | + | violations | 12 | + | lines_to_cover | 31 | + | coverage | 53.8 | + | line_coverage | 54.8 | + | branch_coverage | 50 | + | uncovered_conditions | 4 | + | uncovered_lines | 14 | + | tests | 5 | + | test_failures | 2 | + | test_errors | 0 | + | skipped_tests | 1 | + | test_execution_time | 159 | + | test_success_density | None | + | false_positive_issues | 0 | + | open_issues | 12 | + | confirmed_issues | 0 | + | reopened_issues | 0 | + | code_smells | 6 | + | sqale_index | 30 | + | sqale_debt_ratio | 1.8 | + | bugs | 6 | + | reliability_remediation_effort | 30 | + | vulnerabilities | 0 | + | security_remediation_effort | 0 | + | security_hotspots | 0 | + + Scenario: Project using Bullseye coverage, xUnit, Cppcheck, Rats, Vera++ This test verifies that analysis is able to import Bullseye coverage reports and import custom rules reports. Custom rules are created using Rest API, after test ends rules are deleted. diff --git a/integration-tests/testdata/smoketest_project/Readme.txt b/integration-tests/testdata/smoketest_project/Readme.txt index 58fae30ee6..bf6bbb52f1 100644 --- a/integration-tests/testdata/smoketest_project/Readme.txt +++ b/integration-tests/testdata/smoketest_project/Readme.txt @@ -1,4 +1,5 @@ This project is used for integration testing. Tested features: +- files in the folder are UTF-8 without BOM - parsing / ast construction / basic metrics like ncloc, classes etc. - feeding of issues using: - a cppcheck report diff --git a/integration-tests/testdata/smoketest_project_utf16/3rdparty/extlib.cc b/integration-tests/testdata/smoketest_project_utf16/3rdparty/extlib.cc new file mode 100644 index 0000000000..0d33f2021f Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/3rdparty/extlib.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/3rdparty/extlib.hh b/integration-tests/testdata/smoketest_project_utf16/3rdparty/extlib.hh new file mode 100644 index 0000000000..6a8f9dbb66 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/3rdparty/extlib.hh differ diff --git a/integration-tests/testdata/smoketest_project_utf16/Readme.txt b/integration-tests/testdata/smoketest_project_utf16/Readme.txt new file mode 100644 index 0000000000..59d9a5a569 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/Readme.txt differ diff --git a/integration-tests/testdata/smoketest_project_utf16/build/cppcheck-report.xml b/integration-tests/testdata/smoketest_project_utf16/build/cppcheck-report.xml new file mode 100644 index 0000000000..6d2985002b Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/build/cppcheck-report.xml differ diff --git a/integration-tests/testdata/smoketest_project_utf16/build/gcovr-report.xml b/integration-tests/testdata/smoketest_project_utf16/build/gcovr-report.xml new file mode 100644 index 0000000000..d45a98f2bd Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/build/gcovr-report.xml differ diff --git a/integration-tests/testdata/smoketest_project_utf16/build/xunit-report.xml b/integration-tests/testdata/smoketest_project_utf16/build/xunit-report.xml new file mode 100644 index 0000000000..b679001b98 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/build/xunit-report.xml differ diff --git a/integration-tests/testdata/smoketest_project_utf16/sonar-project.properties b/integration-tests/testdata/smoketest_project_utf16/sonar-project.properties new file mode 100644 index 0000000000..cd953c572b --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf16/sonar-project.properties @@ -0,0 +1,28 @@ +# metadata +sonar.projectKey=smoketest_project_utf16 + +# disable SCM support +sonar.scm.disabled=true + +# disable XML sensor +sonar.xml.file.suffixes=.disable-xml + +# file extensions assigned to the cxx programming language +sonar.cxx.file.suffixes=.cxx,.cpp,.cc,.c,.hxx,.hpp,.hh,.h + +# comma-separated paths to directories containing source files +sonar.sources=src + +# comma-separated paths to directories containing test source files +sonar.tests=tests/unittests + +# comma-separated list of directories where the plugin should search for include files +sonar.cxx.includeDirectories=src,3rdparty + +# paths to the reports +sonar.cxx.cppcheck.reportPaths=build/cppcheck-report.xml +sonar.cxx.cobertura.reportPaths=build/gcovr-report*.xml +sonar.cxx.cobertura.itReportPaths=build/gcovr-report*.xml +sonar.cxx.cobertura.overallReportPaths=build/gcovr-report*.xml +sonar.cxx.valgrind.reportPaths=build/valgrind-report.xml +sonar.cxx.xunit.reportPaths=build/xunit-report.xml diff --git a/integration-tests/testdata/smoketest_project_utf16/src/cli/main.cc b/integration-tests/testdata/smoketest_project_utf16/src/cli/main.cc new file mode 100644 index 0000000000..7ae32aee91 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/src/cli/main.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/src/lib/component1.cc b/integration-tests/testdata/smoketest_project_utf16/src/lib/component1.cc new file mode 100644 index 0000000000..4b2a79eada Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/src/lib/component1.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/src/lib/component1.hh b/integration-tests/testdata/smoketest_project_utf16/src/lib/component1.hh new file mode 100644 index 0000000000..bc44dfdfec Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/src/lib/component1.hh differ diff --git a/integration-tests/testdata/smoketest_project_utf16/src/lib/component2.cc b/integration-tests/testdata/smoketest_project_utf16/src/lib/component2.cc new file mode 100644 index 0000000000..4b4acbdbe3 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/src/lib/component2.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/src/package1/fileA.hh b/integration-tests/testdata/smoketest_project_utf16/src/package1/fileA.hh new file mode 100644 index 0000000000..cb24a2e548 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/src/package1/fileA.hh differ diff --git a/integration-tests/testdata/smoketest_project_utf16/src/package2/fileB.hh b/integration-tests/testdata/smoketest_project_utf16/src/package2/fileB.hh new file mode 100644 index 0000000000..054dc89edb Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/src/package2/fileB.hh differ diff --git a/integration-tests/testdata/smoketest_project_utf16/src/package2/fileC.hh b/integration-tests/testdata/smoketest_project_utf16/src/package2/fileC.hh new file mode 100644 index 0000000000..885dc0cda9 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/src/package2/fileC.hh differ diff --git a/integration-tests/testdata/smoketest_project_utf16/src/package2/fileD.hh b/integration-tests/testdata/smoketest_project_utf16/src/package2/fileD.hh new file mode 100644 index 0000000000..8ae8785731 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/src/package2/fileD.hh differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-death-test.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-death-test.h new file mode 100644 index 0000000000..c8f9ac3165 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-death-test.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-message.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-message.h new file mode 100644 index 0000000000..2a5a9c7d06 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-message.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-param-test.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-param-test.h new file mode 100644 index 0000000000..6944944c18 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-param-test.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-printers.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-printers.h new file mode 100644 index 0000000000..185c7f4e53 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-printers.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-spi.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-spi.h new file mode 100644 index 0000000000..c08528b6ca Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-spi.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-test-part.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-test-part.h new file mode 100644 index 0000000000..bacee9d880 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-test-part.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-typed-test.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-typed-test.h new file mode 100644 index 0000000000..7413b78e90 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest-typed-test.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest.h new file mode 100644 index 0000000000..23f515bd4b Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest_pred_impl.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest_pred_impl.h new file mode 100644 index 0000000000..20e4b52675 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest_pred_impl.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest_prod.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest_prod.h new file mode 100644 index 0000000000..17a326fda4 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/gtest_prod.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-death-test-internal.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-death-test-internal.h new file mode 100644 index 0000000000..49123b262b Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-death-test-internal.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-filepath.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-filepath.h new file mode 100644 index 0000000000..fcea5581d2 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-filepath.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-internal.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-internal.h new file mode 100644 index 0000000000..b7b1f88dc8 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-internal.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-linked_ptr.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-linked_ptr.h new file mode 100644 index 0000000000..c340925c36 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-linked_ptr.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util-generated.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util-generated.h new file mode 100644 index 0000000000..99333e2c84 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util-generated.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util.h new file mode 100644 index 0000000000..103d09f39b Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-port.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-port.h new file mode 100644 index 0000000000..098fcd3d80 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-port.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-string.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-string.h new file mode 100644 index 0000000000..0f2b73b860 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-string.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h new file mode 100644 index 0000000000..3d448641d8 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h.pump b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h.pump new file mode 100644 index 0000000000..28949b1b0a Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h.pump differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h new file mode 100644 index 0000000000..6775980fc0 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h.pump b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h.pump new file mode 100644 index 0000000000..d2277bc1ac Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h.pump differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-all.cc b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-all.cc new file mode 100644 index 0000000000..f775119563 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-all.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-death-test.cc b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-death-test.cc new file mode 100644 index 0000000000..d0380905dc Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-death-test.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-filepath.cc b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-filepath.cc new file mode 100644 index 0000000000..dcd6372418 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-filepath.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-internal-inl.h b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-internal-inl.h new file mode 100644 index 0000000000..de7d472259 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-internal-inl.h differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-port.cc b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-port.cc new file mode 100644 index 0000000000..9a0d7e356f Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-port.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-printers.cc b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-printers.cc new file mode 100644 index 0000000000..a78fc30949 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-printers.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-test-part.cc b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-test-part.cc new file mode 100644 index 0000000000..3085155983 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-test-part.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-typed-test.cc b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-typed-test.cc new file mode 100644 index 0000000000..2ac7fb0db6 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest-typed-test.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest.cc b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest.cc new file mode 100644 index 0000000000..05575fbfeb Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest_main.cc b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest_main.cc new file mode 100644 index 0000000000..85fa9bbca1 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/gtest-1.6.0/src/gtest_main.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf16/tests/unittests/test_component1.cc b/integration-tests/testdata/smoketest_project_utf16/tests/unittests/test_component1.cc new file mode 100644 index 0000000000..bcb2f94647 Binary files /dev/null and b/integration-tests/testdata/smoketest_project_utf16/tests/unittests/test_component1.cc differ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/3rdparty/extlib.cc b/integration-tests/testdata/smoketest_project_utf8_bom/3rdparty/extlib.cc new file mode 100644 index 0000000000..37fcb24707 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/3rdparty/extlib.cc @@ -0,0 +1,3 @@ +int very_useful_function(int a, int b){ + return a * b; +} diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/3rdparty/extlib.hh b/integration-tests/testdata/smoketest_project_utf8_bom/3rdparty/extlib.hh new file mode 100644 index 0000000000..ad272ff82f --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/3rdparty/extlib.hh @@ -0,0 +1 @@ +int very_useful_function(int a, int b); diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/Readme.txt b/integration-tests/testdata/smoketest_project_utf8_bom/Readme.txt new file mode 100644 index 0000000000..c44127b92e --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/Readme.txt @@ -0,0 +1,7 @@ +This project is used for integration testing. Tested features: +- files in the folder are UTF-8 with BOM +- parsing / ast construction / basic metrics like ncloc, classes etc. +- feeding of issues using: + - a cppcheck report + - a valgrind report +- unit test statistics, using the junitReport format diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/build/cppcheck-report.xml b/integration-tests/testdata/smoketest_project_utf8_bom/build/cppcheck-report.xml new file mode 100644 index 0000000000..0a25622893 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/build/cppcheck-report.xml @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/build/gcovr-report.xml b/integration-tests/testdata/smoketest_project_utf8_bom/build/gcovr-report.xml new file mode 100644 index 0000000000..5e3909e0c3 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/build/gcovr-report.xml @@ -0,0 +1,48 @@ + + + + + . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/build/xunit-report.xml b/integration-tests/testdata/smoketest_project_utf8_bom/build/xunit-report.xml new file mode 100644 index 0000000000..0b423538e9 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/build/xunit-report.xml @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/sonar-project.properties b/integration-tests/testdata/smoketest_project_utf8_bom/sonar-project.properties new file mode 100644 index 0000000000..f3044517ae --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/sonar-project.properties @@ -0,0 +1,28 @@ +# metadata +sonar.projectKey=smoketest_project_utf8_bom + +# disable SCM support +sonar.scm.disabled=true + +# disable XML sensor +sonar.xml.file.suffixes=.disable-xml + +# file extensions assigned to the cxx programming language +sonar.cxx.file.suffixes=.cxx,.cpp,.cc,.c,.hxx,.hpp,.hh,.h + +# comma-separated paths to directories containing source files +sonar.sources=src + +# comma-separated paths to directories containing test source files +sonar.tests=tests/unittests + +# comma-separated list of directories where the plugin should search for include files +sonar.cxx.includeDirectories=src,3rdparty + +# paths to the reports +sonar.cxx.cppcheck.reportPaths=build/cppcheck-report.xml +sonar.cxx.cobertura.reportPaths=build/gcovr-report*.xml +sonar.cxx.cobertura.itReportPaths=build/gcovr-report*.xml +sonar.cxx.cobertura.overallReportPaths=build/gcovr-report*.xml +sonar.cxx.valgrind.reportPaths=build/valgrind-report.xml +sonar.cxx.xunit.reportPaths=build/xunit-report.xml diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/src/cli/main.cc b/integration-tests/testdata/smoketest_project_utf8_bom/src/cli/main.cc new file mode 100644 index 0000000000..72a4099407 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/src/cli/main.cc @@ -0,0 +1,11 @@ +#include +#include +#include +#include +#include + +int main(int argc, char* argv[]) +{ + std::cout << "Here is main" << std::endl; + return Bar().foo(); +} diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/src/lib/component1.cc b/integration-tests/testdata/smoketest_project_utf8_bom/src/lib/component1.cc new file mode 100644 index 0000000000..8017786877 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/src/lib/component1.cc @@ -0,0 +1,52 @@ +#include + +#include \ + "component1.hh" + +/** + * Does something + * + * @return: an int indicating something + */ +int Bar::foo(){ + // single line comment + + /* + * multi-line comment + */ + int \ + x; //unused variable + + return 111; +} + + +void Bar::do_valgrind_errors(){ + ///// lets provoke some valgrind errors ///// + + // Memory leak (definitely lost) + new float(); + + // Condition depends on undefined value + int a; + if(a) std::cout << "fired!!!" << std::endl; + + // Invalid read + int* ip = new int(0); + delete ip; + int i = *ip; + + // Invalid write + ip = new int(0); + delete ip; + *ip = 1; + + // Invalid free + ip = new int(0); + delete ip; + delete ip; + + // Mismatched free() / delete / delete [] + ip = new int(0); + delete [] ip; +} diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/src/lib/component1.hh b/integration-tests/testdata/smoketest_project_utf8_bom/src/lib/component1.hh new file mode 100644 index 0000000000..c41484d261 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/src/lib/component1.hh @@ -0,0 +1,9 @@ +#ifndef COMPONENT1_HH +#define COMPONENT1_HH + +class Bar { +public: + int foo(); + void do_valgrind_errors(); +}; +#endif diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/src/lib/component2.cc b/integration-tests/testdata/smoketest_project_utf8_bom/src/lib/component2.cc new file mode 100644 index 0000000000..ab4b4d0dcc --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/src/lib/component2.cc @@ -0,0 +1,51 @@ +#include + +#include "component1.hh" + +/** + * Does something + * + * @return: an int indicating something + */ +int Bar::foo(){ + // single line comment + + /* + * multi-line comment + */ + int \ + x; //unused variable + + return 111; +} + + +void Bar::do_valgrind_errors(){ + ///// lets provoke some valgrind errors ///// + + // Memory leak (definitely lost) + new float(); + + // Condition depends on undefined value + int a; + if(a) std::cout << "fired!!!" << std::endl; + + // Invalid read + int* ip = new int(0); + delete ip; + int i = *ip; + + // Invalid write + ip = new int(0); + delete ip; + *ip = 1; + + // Invalid free + ip = new int(0); + delete ip; + delete ip; + + // Mismatched free() / delete / delete [] + ip = new int(0); + delete [] ip; +} diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/src/package1/fileA.hh b/integration-tests/testdata/smoketest_project_utf8_bom/src/package1/fileA.hh new file mode 100644 index 0000000000..2fada316ca --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/src/package1/fileA.hh @@ -0,0 +1,5 @@ +#ifndef FILEA +#define FILEA +#include "../package2/fileB.hh" +void foo1(); +#endif diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/src/package2/fileB.hh b/integration-tests/testdata/smoketest_project_utf8_bom/src/package2/fileB.hh new file mode 100644 index 0000000000..9df37641f3 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/src/package2/fileB.hh @@ -0,0 +1,5 @@ +#ifndef FILEB +#define FILEB +#include "../package1/fileA.hh" +void foob(); +#endif diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/src/package2/fileC.hh b/integration-tests/testdata/smoketest_project_utf8_bom/src/package2/fileC.hh new file mode 100644 index 0000000000..912e797ae5 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/src/package2/fileC.hh @@ -0,0 +1,5 @@ +#ifndef FILEC +#define FILEC +#include "fileD.hh" +void fooc(); +#endif diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/src/package2/fileD.hh b/integration-tests/testdata/smoketest_project_utf8_bom/src/package2/fileD.hh new file mode 100644 index 0000000000..b1038326ca --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/src/package2/fileD.hh @@ -0,0 +1,5 @@ +#ifndef FILED +#define FILED +#include "fileC.hh" +void food(); +#endif diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-death-test.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-death-test.h new file mode 100644 index 0000000000..81e2cbb983 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-death-test.h @@ -0,0 +1,283 @@ +// Copyright 2005, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) +// +// The Google C++ Testing Framework (Google Test) +// +// This header file defines the public API for death tests. It is +// #included by gtest.h so a user doesn't need to include this +// directly. + +#ifndef GTEST_INCLUDE_GTEST_GTEST_DEATH_TEST_H_ +#define GTEST_INCLUDE_GTEST_GTEST_DEATH_TEST_H_ + +#include "gtest/internal/gtest-death-test-internal.h" + +namespace testing { + +// This flag controls the style of death tests. Valid values are "threadsafe", +// meaning that the death test child process will re-execute the test binary +// from the start, running only a single death test, or "fast", +// meaning that the child process will execute the test logic immediately +// after forking. +GTEST_DECLARE_string_(death_test_style); + +#if GTEST_HAS_DEATH_TEST + +// The following macros are useful for writing death tests. + +// Here's what happens when an ASSERT_DEATH* or EXPECT_DEATH* is +// executed: +// +// 1. It generates a warning if there is more than one active +// thread. This is because it's safe to fork() or clone() only +// when there is a single thread. +// +// 2. The parent process clone()s a sub-process and runs the death +// test in it; the sub-process exits with code 0 at the end of the +// death test, if it hasn't exited already. +// +// 3. The parent process waits for the sub-process to terminate. +// +// 4. The parent process checks the exit code and error message of +// the sub-process. +// +// Examples: +// +// ASSERT_DEATH(server.SendMessage(56, "Hello"), "Invalid port number"); +// for (int i = 0; i < 5; i++) { +// EXPECT_DEATH(server.ProcessRequest(i), +// "Invalid request .* in ProcessRequest()") +// << "Failed to die on request " << i); +// } +// +// ASSERT_EXIT(server.ExitNow(), ::testing::ExitedWithCode(0), "Exiting"); +// +// bool KilledBySIGHUP(int exit_code) { +// return WIFSIGNALED(exit_code) && WTERMSIG(exit_code) == SIGHUP; +// } +// +// ASSERT_EXIT(client.HangUpServer(), KilledBySIGHUP, "Hanging up!"); +// +// On the regular expressions used in death tests: +// +// On POSIX-compliant systems (*nix), we use the library, +// which uses the POSIX extended regex syntax. +// +// On other platforms (e.g. Windows), we only support a simple regex +// syntax implemented as part of Google Test. This limited +// implementation should be enough most of the time when writing +// death tests; though it lacks many features you can find in PCRE +// or POSIX extended regex syntax. For example, we don't support +// union ("x|y"), grouping ("(xy)"), brackets ("[xy]"), and +// repetition count ("x{5,7}"), among others. +// +// Below is the syntax that we do support. We chose it to be a +// subset of both PCRE and POSIX extended regex, so it's easy to +// learn wherever you come from. In the following: 'A' denotes a +// literal character, period (.), or a single \\ escape sequence; +// 'x' and 'y' denote regular expressions; 'm' and 'n' are for +// natural numbers. +// +// c matches any literal character c +// \\d matches any decimal digit +// \\D matches any character that's not a decimal digit +// \\f matches \f +// \\n matches \n +// \\r matches \r +// \\s matches any ASCII whitespace, including \n +// \\S matches any character that's not a whitespace +// \\t matches \t +// \\v matches \v +// \\w matches any letter, _, or decimal digit +// \\W matches any character that \\w doesn't match +// \\c matches any literal character c, which must be a punctuation +// . matches any single character except \n +// A? matches 0 or 1 occurrences of A +// A* matches 0 or many occurrences of A +// A+ matches 1 or many occurrences of A +// ^ matches the beginning of a string (not that of each line) +// $ matches the end of a string (not that of each line) +// xy matches x followed by y +// +// If you accidentally use PCRE or POSIX extended regex features +// not implemented by us, you will get a run-time failure. In that +// case, please try to rewrite your regular expression within the +// above syntax. +// +// This implementation is *not* meant to be as highly tuned or robust +// as a compiled regex library, but should perform well enough for a +// death test, which already incurs significant overhead by launching +// a child process. +// +// Known caveats: +// +// A "threadsafe" style death test obtains the path to the test +// program from argv[0] and re-executes it in the sub-process. For +// simplicity, the current implementation doesn't search the PATH +// when launching the sub-process. This means that the user must +// invoke the test program via a path that contains at least one +// path separator (e.g. path/to/foo_test and +// /absolute/path/to/bar_test are fine, but foo_test is not). This +// is rarely a problem as people usually don't put the test binary +// directory in PATH. +// +// TODO(wan@google.com): make thread-safe death tests search the PATH. + +// Asserts that a given statement causes the program to exit, with an +// integer exit status that satisfies predicate, and emitting error output +// that matches regex. +# define ASSERT_EXIT(statement, predicate, regex) \ + GTEST_DEATH_TEST_(statement, predicate, regex, GTEST_FATAL_FAILURE_) + +// Like ASSERT_EXIT, but continues on to successive tests in the +// test case, if any: +# define EXPECT_EXIT(statement, predicate, regex) \ + GTEST_DEATH_TEST_(statement, predicate, regex, GTEST_NONFATAL_FAILURE_) + +// Asserts that a given statement causes the program to exit, either by +// explicitly exiting with a nonzero exit code or being killed by a +// signal, and emitting error output that matches regex. +# define ASSERT_DEATH(statement, regex) \ + ASSERT_EXIT(statement, ::testing::internal::ExitedUnsuccessfully, regex) + +// Like ASSERT_DEATH, but continues on to successive tests in the +// test case, if any: +# define EXPECT_DEATH(statement, regex) \ + EXPECT_EXIT(statement, ::testing::internal::ExitedUnsuccessfully, regex) + +// Two predicate classes that can be used in {ASSERT,EXPECT}_EXIT*: + +// Tests that an exit code describes a normal exit with a given exit code. +class GTEST_API_ ExitedWithCode { + public: + explicit ExitedWithCode(int exit_code); + bool operator()(int exit_status) const; + private: + // No implementation - assignment is unsupported. + void operator=(const ExitedWithCode& other); + + const int exit_code_; +}; + +# if !GTEST_OS_WINDOWS +// Tests that an exit code describes an exit due to termination by a +// given signal. +class GTEST_API_ KilledBySignal { + public: + explicit KilledBySignal(int signum); + bool operator()(int exit_status) const; + private: + const int signum_; +}; +# endif // !GTEST_OS_WINDOWS + +// EXPECT_DEBUG_DEATH asserts that the given statements die in debug mode. +// The death testing framework causes this to have interesting semantics, +// since the sideeffects of the call are only visible in opt mode, and not +// in debug mode. +// +// In practice, this can be used to test functions that utilize the +// LOG(DFATAL) macro using the following style: +// +// int DieInDebugOr12(int* sideeffect) { +// if (sideeffect) { +// *sideeffect = 12; +// } +// LOG(DFATAL) << "death"; +// return 12; +// } +// +// TEST(TestCase, TestDieOr12WorksInDgbAndOpt) { +// int sideeffect = 0; +// // Only asserts in dbg. +// EXPECT_DEBUG_DEATH(DieInDebugOr12(&sideeffect), "death"); +// +// #ifdef NDEBUG +// // opt-mode has sideeffect visible. +// EXPECT_EQ(12, sideeffect); +// #else +// // dbg-mode no visible sideeffect. +// EXPECT_EQ(0, sideeffect); +// #endif +// } +// +// This will assert that DieInDebugReturn12InOpt() crashes in debug +// mode, usually due to a DCHECK or LOG(DFATAL), but returns the +// appropriate fallback value (12 in this case) in opt mode. If you +// need to test that a function has appropriate side-effects in opt +// mode, include assertions against the side-effects. A general +// pattern for this is: +// +// EXPECT_DEBUG_DEATH({ +// // Side-effects here will have an effect after this statement in +// // opt mode, but none in debug mode. +// EXPECT_EQ(12, DieInDebugOr12(&sideeffect)); +// }, "death"); +// +# ifdef NDEBUG + +# define EXPECT_DEBUG_DEATH(statement, regex) \ + do { statement; } while (::testing::internal::AlwaysFalse()) + +# define ASSERT_DEBUG_DEATH(statement, regex) \ + do { statement; } while (::testing::internal::AlwaysFalse()) + +# else + +# define EXPECT_DEBUG_DEATH(statement, regex) \ + EXPECT_DEATH(statement, regex) + +# define ASSERT_DEBUG_DEATH(statement, regex) \ + ASSERT_DEATH(statement, regex) + +# endif // NDEBUG for EXPECT_DEBUG_DEATH +#endif // GTEST_HAS_DEATH_TEST + +// EXPECT_DEATH_IF_SUPPORTED(statement, regex) and +// ASSERT_DEATH_IF_SUPPORTED(statement, regex) expand to real death tests if +// death tests are supported; otherwise they just issue a warning. This is +// useful when you are combining death test assertions with normal test +// assertions in one test. +#if GTEST_HAS_DEATH_TEST +# define EXPECT_DEATH_IF_SUPPORTED(statement, regex) \ + EXPECT_DEATH(statement, regex) +# define ASSERT_DEATH_IF_SUPPORTED(statement, regex) \ + ASSERT_DEATH(statement, regex) +#else +# define EXPECT_DEATH_IF_SUPPORTED(statement, regex) \ + GTEST_UNSUPPORTED_DEATH_TEST_(statement, regex, ) +# define ASSERT_DEATH_IF_SUPPORTED(statement, regex) \ + GTEST_UNSUPPORTED_DEATH_TEST_(statement, regex, return) +#endif + +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_GTEST_DEATH_TEST_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-message.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-message.h new file mode 100644 index 0000000000..41239b37b9 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-message.h @@ -0,0 +1,230 @@ +// Copyright 2005, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) +// +// The Google C++ Testing Framework (Google Test) +// +// This header file defines the Message class. +// +// IMPORTANT NOTE: Due to limitation of the C++ language, we have to +// leave some internal implementation details in this header file. +// They are clearly marked by comments like this: +// +// // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +// +// Such code is NOT meant to be used by a user directly, and is subject +// to CHANGE WITHOUT NOTICE. Therefore DO NOT DEPEND ON IT in a user +// program! + +#ifndef GTEST_INCLUDE_GTEST_GTEST_MESSAGE_H_ +#define GTEST_INCLUDE_GTEST_GTEST_MESSAGE_H_ + +#include + +#include "gtest/internal/gtest-string.h" +#include "gtest/internal/gtest-internal.h" + +namespace testing { + +// The Message class works like an ostream repeater. +// +// Typical usage: +// +// 1. You stream a bunch of values to a Message object. +// It will remember the text in a stringstream. +// 2. Then you stream the Message object to an ostream. +// This causes the text in the Message to be streamed +// to the ostream. +// +// For example; +// +// testing::Message foo; +// foo << 1 << " != " << 2; +// std::cout << foo; +// +// will print "1 != 2". +// +// Message is not intended to be inherited from. In particular, its +// destructor is not virtual. +// +// Note that stringstream behaves differently in gcc and in MSVC. You +// can stream a NULL char pointer to it in the former, but not in the +// latter (it causes an access violation if you do). The Message +// class hides this difference by treating a NULL char pointer as +// "(null)". +class GTEST_API_ Message { + private: + // The type of basic IO manipulators (endl, ends, and flush) for + // narrow streams. + typedef std::ostream& (*BasicNarrowIoManip)(std::ostream&); + + public: + // Constructs an empty Message. + // We allocate the stringstream separately because otherwise each use of + // ASSERT/EXPECT in a procedure adds over 200 bytes to the procedure's + // stack frame leading to huge stack frames in some cases; gcc does not reuse + // the stack space. + Message() : ss_(new ::std::stringstream) { + // By default, we want there to be enough precision when printing + // a double to a Message. + *ss_ << std::setprecision(std::numeric_limits::digits10 + 2); + } + + // Copy constructor. + Message(const Message& msg) : ss_(new ::std::stringstream) { // NOLINT + *ss_ << msg.GetString(); + } + + // Constructs a Message from a C-string. + explicit Message(const char* str) : ss_(new ::std::stringstream) { + *ss_ << str; + } + +#if GTEST_OS_SYMBIAN + // Streams a value (either a pointer or not) to this object. + template + inline Message& operator <<(const T& value) { + StreamHelper(typename internal::is_pointer::type(), value); + return *this; + } +#else + // Streams a non-pointer value to this object. + template + inline Message& operator <<(const T& val) { + ::GTestStreamToHelper(ss_.get(), val); + return *this; + } + + // Streams a pointer value to this object. + // + // This function is an overload of the previous one. When you + // stream a pointer to a Message, this definition will be used as it + // is more specialized. (The C++ Standard, section + // [temp.func.order].) If you stream a non-pointer, then the + // previous definition will be used. + // + // The reason for this overload is that streaming a NULL pointer to + // ostream is undefined behavior. Depending on the compiler, you + // may get "0", "(nil)", "(null)", or an access violation. To + // ensure consistent result across compilers, we always treat NULL + // as "(null)". + template + inline Message& operator <<(T* const& pointer) { // NOLINT + if (pointer == NULL) { + *ss_ << "(null)"; + } else { + ::GTestStreamToHelper(ss_.get(), pointer); + } + return *this; + } +#endif // GTEST_OS_SYMBIAN + + // Since the basic IO manipulators are overloaded for both narrow + // and wide streams, we have to provide this specialized definition + // of operator <<, even though its body is the same as the + // templatized version above. Without this definition, streaming + // endl or other basic IO manipulators to Message will confuse the + // compiler. + Message& operator <<(BasicNarrowIoManip val) { + *ss_ << val; + return *this; + } + + // Instead of 1/0, we want to see true/false for bool values. + Message& operator <<(bool b) { + return *this << (b ? "true" : "false"); + } + + // These two overloads allow streaming a wide C string to a Message + // using the UTF-8 encoding. + Message& operator <<(const wchar_t* wide_c_str) { + return *this << internal::String::ShowWideCString(wide_c_str); + } + Message& operator <<(wchar_t* wide_c_str) { + return *this << internal::String::ShowWideCString(wide_c_str); + } + +#if GTEST_HAS_STD_WSTRING + // Converts the given wide string to a narrow string using the UTF-8 + // encoding, and streams the result to this Message object. + Message& operator <<(const ::std::wstring& wstr); +#endif // GTEST_HAS_STD_WSTRING + +#if GTEST_HAS_GLOBAL_WSTRING + // Converts the given wide string to a narrow string using the UTF-8 + // encoding, and streams the result to this Message object. + Message& operator <<(const ::wstring& wstr); +#endif // GTEST_HAS_GLOBAL_WSTRING + + // Gets the text streamed to this object so far as a String. + // Each '\0' character in the buffer is replaced with "\\0". + // + // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. + internal::String GetString() const { + return internal::StringStreamToString(ss_.get()); + } + + private: + +#if GTEST_OS_SYMBIAN + // These are needed as the Nokia Symbian Compiler cannot decide between + // const T& and const T* in a function template. The Nokia compiler _can_ + // decide between class template specializations for T and T*, so a + // tr1::type_traits-like is_pointer works, and we can overload on that. + template + inline void StreamHelper(internal::true_type /*dummy*/, T* pointer) { + if (pointer == NULL) { + *ss_ << "(null)"; + } else { + ::GTestStreamToHelper(ss_.get(), pointer); + } + } + template + inline void StreamHelper(internal::false_type /*dummy*/, const T& value) { + ::GTestStreamToHelper(ss_.get(), value); + } +#endif // GTEST_OS_SYMBIAN + + // We'll hold the text streamed to this object here. + const internal::scoped_ptr< ::std::stringstream> ss_; + + // We declare (but don't implement) this to prevent the compiler + // from implementing the assignment operator. + void operator=(const Message&); +}; + +// Streams a Message to an ostream. +inline std::ostream& operator <<(std::ostream& os, const Message& sb) { + return os << sb.GetString(); +} + +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_GTEST_MESSAGE_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-param-test.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-param-test.h new file mode 100644 index 0000000000..27b4d12579 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-param-test.h @@ -0,0 +1,1421 @@ +// This file was GENERATED by command: +// pump.py gtest-param-test.h.pump +// DO NOT EDIT BY HAND!!! + +// Copyright 2008, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Authors: vladl@google.com (Vlad Losev) +// +// Macros and functions for implementing parameterized tests +// in Google C++ Testing Framework (Google Test) +// +// This file is generated by a SCRIPT. DO NOT EDIT BY HAND! +// +#ifndef GTEST_INCLUDE_GTEST_GTEST_PARAM_TEST_H_ +#define GTEST_INCLUDE_GTEST_GTEST_PARAM_TEST_H_ + + +// Value-parameterized tests allow you to test your code with different +// parameters without writing multiple copies of the same test. +// +// Here is how you use value-parameterized tests: + +#if 0 + +// To write value-parameterized tests, first you should define a fixture +// class. It is usually derived from testing::TestWithParam (see below for +// another inheritance scheme that's sometimes useful in more complicated +// class hierarchies), where the type of your parameter values. +// TestWithParam is itself derived from testing::Test. T can be any +// copyable type. If it's a raw pointer, you are responsible for managing the +// lifespan of the pointed values. + +class FooTest : public ::testing::TestWithParam { + // You can implement all the usual class fixture members here. +}; + +// Then, use the TEST_P macro to define as many parameterized tests +// for this fixture as you want. The _P suffix is for "parameterized" +// or "pattern", whichever you prefer to think. + +TEST_P(FooTest, DoesBlah) { + // Inside a test, access the test parameter with the GetParam() method + // of the TestWithParam class: + EXPECT_TRUE(foo.Blah(GetParam())); + ... +} + +TEST_P(FooTest, HasBlahBlah) { + ... +} + +// Finally, you can use INSTANTIATE_TEST_CASE_P to instantiate the test +// case with any set of parameters you want. Google Test defines a number +// of functions for generating test parameters. They return what we call +// (surprise!) parameter generators. Here is a summary of them, which +// are all in the testing namespace: +// +// +// Range(begin, end [, step]) - Yields values {begin, begin+step, +// begin+step+step, ...}. The values do not +// include end. step defaults to 1. +// Values(v1, v2, ..., vN) - Yields values {v1, v2, ..., vN}. +// ValuesIn(container) - Yields values from a C-style array, an STL +// ValuesIn(begin,end) container, or an iterator range [begin, end). +// Bool() - Yields sequence {false, true}. +// Combine(g1, g2, ..., gN) - Yields all combinations (the Cartesian product +// for the math savvy) of the values generated +// by the N generators. +// +// For more details, see comments at the definitions of these functions below +// in this file. +// +// The following statement will instantiate tests from the FooTest test case +// each with parameter values "meeny", "miny", and "moe". + +INSTANTIATE_TEST_CASE_P(InstantiationName, + FooTest, + Values("meeny", "miny", "moe")); + +// To distinguish different instances of the pattern, (yes, you +// can instantiate it more then once) the first argument to the +// INSTANTIATE_TEST_CASE_P macro is a prefix that will be added to the +// actual test case name. Remember to pick unique prefixes for different +// instantiations. The tests from the instantiation above will have +// these names: +// +// * InstantiationName/FooTest.DoesBlah/0 for "meeny" +// * InstantiationName/FooTest.DoesBlah/1 for "miny" +// * InstantiationName/FooTest.DoesBlah/2 for "moe" +// * InstantiationName/FooTest.HasBlahBlah/0 for "meeny" +// * InstantiationName/FooTest.HasBlahBlah/1 for "miny" +// * InstantiationName/FooTest.HasBlahBlah/2 for "moe" +// +// You can use these names in --gtest_filter. +// +// This statement will instantiate all tests from FooTest again, each +// with parameter values "cat" and "dog": + +const char* pets[] = {"cat", "dog"}; +INSTANTIATE_TEST_CASE_P(AnotherInstantiationName, FooTest, ValuesIn(pets)); + +// The tests from the instantiation above will have these names: +// +// * AnotherInstantiationName/FooTest.DoesBlah/0 for "cat" +// * AnotherInstantiationName/FooTest.DoesBlah/1 for "dog" +// * AnotherInstantiationName/FooTest.HasBlahBlah/0 for "cat" +// * AnotherInstantiationName/FooTest.HasBlahBlah/1 for "dog" +// +// Please note that INSTANTIATE_TEST_CASE_P will instantiate all tests +// in the given test case, whether their definitions come before or +// AFTER the INSTANTIATE_TEST_CASE_P statement. +// +// Please also note that generator expressions (including parameters to the +// generators) are evaluated in InitGoogleTest(), after main() has started. +// This allows the user on one hand, to adjust generator parameters in order +// to dynamically determine a set of tests to run and on the other hand, +// give the user a chance to inspect the generated tests with Google Test +// reflection API before RUN_ALL_TESTS() is executed. +// +// You can see samples/sample7_unittest.cc and samples/sample8_unittest.cc +// for more examples. +// +// In the future, we plan to publish the API for defining new parameter +// generators. But for now this interface remains part of the internal +// implementation and is subject to change. +// +// +// A parameterized test fixture must be derived from testing::Test and from +// testing::WithParamInterface, where T is the type of the parameter +// values. Inheriting from TestWithParam satisfies that requirement because +// TestWithParam inherits from both Test and WithParamInterface. In more +// complicated hierarchies, however, it is occasionally useful to inherit +// separately from Test and WithParamInterface. For example: + +class BaseTest : public ::testing::Test { + // You can inherit all the usual members for a non-parameterized test + // fixture here. +}; + +class DerivedTest : public BaseTest, public ::testing::WithParamInterface { + // The usual test fixture members go here too. +}; + +TEST_F(BaseTest, HasFoo) { + // This is an ordinary non-parameterized test. +} + +TEST_P(DerivedTest, DoesBlah) { + // GetParam works just the same here as if you inherit from TestWithParam. + EXPECT_TRUE(foo.Blah(GetParam())); +} + +#endif // 0 + +#include "gtest/internal/gtest-port.h" + +#if !GTEST_OS_SYMBIAN +# include +#endif + +// scripts/fuse_gtest.py depends on gtest's own header being #included +// *unconditionally*. Therefore these #includes cannot be moved +// inside #if GTEST_HAS_PARAM_TEST. +#include "gtest/internal/gtest-internal.h" +#include "gtest/internal/gtest-param-util.h" +#include "gtest/internal/gtest-param-util-generated.h" + +#if GTEST_HAS_PARAM_TEST + +namespace testing { + +// Functions producing parameter generators. +// +// Google Test uses these generators to produce parameters for value- +// parameterized tests. When a parameterized test case is instantiated +// with a particular generator, Google Test creates and runs tests +// for each element in the sequence produced by the generator. +// +// In the following sample, tests from test case FooTest are instantiated +// each three times with parameter values 3, 5, and 8: +// +// class FooTest : public TestWithParam { ... }; +// +// TEST_P(FooTest, TestThis) { +// } +// TEST_P(FooTest, TestThat) { +// } +// INSTANTIATE_TEST_CASE_P(TestSequence, FooTest, Values(3, 5, 8)); +// + +// Range() returns generators providing sequences of values in a range. +// +// Synopsis: +// Range(start, end) +// - returns a generator producing a sequence of values {start, start+1, +// start+2, ..., }. +// Range(start, end, step) +// - returns a generator producing a sequence of values {start, start+step, +// start+step+step, ..., }. +// Notes: +// * The generated sequences never include end. For example, Range(1, 5) +// returns a generator producing a sequence {1, 2, 3, 4}. Range(1, 9, 2) +// returns a generator producing {1, 3, 5, 7}. +// * start and end must have the same type. That type may be any integral or +// floating-point type or a user defined type satisfying these conditions: +// * It must be assignable (have operator=() defined). +// * It must have operator+() (operator+(int-compatible type) for +// two-operand version). +// * It must have operator<() defined. +// Elements in the resulting sequences will also have that type. +// * Condition start < end must be satisfied in order for resulting sequences +// to contain any elements. +// +template +internal::ParamGenerator Range(T start, T end, IncrementT step) { + return internal::ParamGenerator( + new internal::RangeGenerator(start, end, step)); +} + +template +internal::ParamGenerator Range(T start, T end) { + return Range(start, end, 1); +} + +// ValuesIn() function allows generation of tests with parameters coming from +// a container. +// +// Synopsis: +// ValuesIn(const T (&array)[N]) +// - returns a generator producing sequences with elements from +// a C-style array. +// ValuesIn(const Container& container) +// - returns a generator producing sequences with elements from +// an STL-style container. +// ValuesIn(Iterator begin, Iterator end) +// - returns a generator producing sequences with elements from +// a range [begin, end) defined by a pair of STL-style iterators. These +// iterators can also be plain C pointers. +// +// Please note that ValuesIn copies the values from the containers +// passed in and keeps them to generate tests in RUN_ALL_TESTS(). +// +// Examples: +// +// This instantiates tests from test case StringTest +// each with C-string values of "foo", "bar", and "baz": +// +// const char* strings[] = {"foo", "bar", "baz"}; +// INSTANTIATE_TEST_CASE_P(StringSequence, SrtingTest, ValuesIn(strings)); +// +// This instantiates tests from test case StlStringTest +// each with STL strings with values "a" and "b": +// +// ::std::vector< ::std::string> GetParameterStrings() { +// ::std::vector< ::std::string> v; +// v.push_back("a"); +// v.push_back("b"); +// return v; +// } +// +// INSTANTIATE_TEST_CASE_P(CharSequence, +// StlStringTest, +// ValuesIn(GetParameterStrings())); +// +// +// This will also instantiate tests from CharTest +// each with parameter values 'a' and 'b': +// +// ::std::list GetParameterChars() { +// ::std::list list; +// list.push_back('a'); +// list.push_back('b'); +// return list; +// } +// ::std::list l = GetParameterChars(); +// INSTANTIATE_TEST_CASE_P(CharSequence2, +// CharTest, +// ValuesIn(l.begin(), l.end())); +// +template +internal::ParamGenerator< + typename ::testing::internal::IteratorTraits::value_type> +ValuesIn(ForwardIterator begin, ForwardIterator end) { + typedef typename ::testing::internal::IteratorTraits + ::value_type ParamType; + return internal::ParamGenerator( + new internal::ValuesInIteratorRangeGenerator(begin, end)); +} + +template +internal::ParamGenerator ValuesIn(const T (&array)[N]) { + return ValuesIn(array, array + N); +} + +template +internal::ParamGenerator ValuesIn( + const Container& container) { + return ValuesIn(container.begin(), container.end()); +} + +// Values() allows generating tests from explicitly specified list of +// parameters. +// +// Synopsis: +// Values(T v1, T v2, ..., T vN) +// - returns a generator producing sequences with elements v1, v2, ..., vN. +// +// For example, this instantiates tests from test case BarTest each +// with values "one", "two", and "three": +// +// INSTANTIATE_TEST_CASE_P(NumSequence, BarTest, Values("one", "two", "three")); +// +// This instantiates tests from test case BazTest each with values 1, 2, 3.5. +// The exact type of values will depend on the type of parameter in BazTest. +// +// INSTANTIATE_TEST_CASE_P(FloatingNumbers, BazTest, Values(1, 2, 3.5)); +// +// Currently, Values() supports from 1 to 50 parameters. +// +template +internal::ValueArray1 Values(T1 v1) { + return internal::ValueArray1(v1); +} + +template +internal::ValueArray2 Values(T1 v1, T2 v2) { + return internal::ValueArray2(v1, v2); +} + +template +internal::ValueArray3 Values(T1 v1, T2 v2, T3 v3) { + return internal::ValueArray3(v1, v2, v3); +} + +template +internal::ValueArray4 Values(T1 v1, T2 v2, T3 v3, T4 v4) { + return internal::ValueArray4(v1, v2, v3, v4); +} + +template +internal::ValueArray5 Values(T1 v1, T2 v2, T3 v3, T4 v4, + T5 v5) { + return internal::ValueArray5(v1, v2, v3, v4, v5); +} + +template +internal::ValueArray6 Values(T1 v1, T2 v2, T3 v3, + T4 v4, T5 v5, T6 v6) { + return internal::ValueArray6(v1, v2, v3, v4, v5, v6); +} + +template +internal::ValueArray7 Values(T1 v1, T2 v2, T3 v3, + T4 v4, T5 v5, T6 v6, T7 v7) { + return internal::ValueArray7(v1, v2, v3, v4, v5, + v6, v7); +} + +template +internal::ValueArray8 Values(T1 v1, T2 v2, + T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8) { + return internal::ValueArray8(v1, v2, v3, v4, + v5, v6, v7, v8); +} + +template +internal::ValueArray9 Values(T1 v1, T2 v2, + T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9) { + return internal::ValueArray9(v1, v2, v3, + v4, v5, v6, v7, v8, v9); +} + +template +internal::ValueArray10 Values(T1 v1, + T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10) { + return internal::ValueArray10(v1, + v2, v3, v4, v5, v6, v7, v8, v9, v10); +} + +template +internal::ValueArray11 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11) { + return internal::ValueArray11(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11); +} + +template +internal::ValueArray12 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12) { + return internal::ValueArray12(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12); +} + +template +internal::ValueArray13 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13) { + return internal::ValueArray13(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13); +} + +template +internal::ValueArray14 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14) { + return internal::ValueArray14(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, + v14); +} + +template +internal::ValueArray15 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, + T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15) { + return internal::ValueArray15(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, + v13, v14, v15); +} + +template +internal::ValueArray16 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, + T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, + T16 v16) { + return internal::ValueArray16(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, + v12, v13, v14, v15, v16); +} + +template +internal::ValueArray17 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, + T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, + T16 v16, T17 v17) { + return internal::ValueArray17(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, + v11, v12, v13, v14, v15, v16, v17); +} + +template +internal::ValueArray18 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, + T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, + T16 v16, T17 v17, T18 v18) { + return internal::ValueArray18(v1, v2, v3, v4, v5, v6, v7, v8, v9, + v10, v11, v12, v13, v14, v15, v16, v17, v18); +} + +template +internal::ValueArray19 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, + T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, + T15 v15, T16 v16, T17 v17, T18 v18, T19 v19) { + return internal::ValueArray19(v1, v2, v3, v4, v5, v6, v7, v8, + v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19); +} + +template +internal::ValueArray20 Values(T1 v1, T2 v2, T3 v3, T4 v4, + T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, + T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20) { + return internal::ValueArray20(v1, v2, v3, v4, v5, v6, v7, + v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20); +} + +template +internal::ValueArray21 Values(T1 v1, T2 v2, T3 v3, T4 v4, + T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, + T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21) { + return internal::ValueArray21(v1, v2, v3, v4, v5, v6, + v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21); +} + +template +internal::ValueArray22 Values(T1 v1, T2 v2, T3 v3, + T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, + T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, + T21 v21, T22 v22) { + return internal::ValueArray22(v1, v2, v3, v4, + v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, + v20, v21, v22); +} + +template +internal::ValueArray23 Values(T1 v1, T2 v2, + T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, + T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, + T21 v21, T22 v22, T23 v23) { + return internal::ValueArray23(v1, v2, v3, + v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, + v20, v21, v22, v23); +} + +template +internal::ValueArray24 Values(T1 v1, T2 v2, + T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, + T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, + T21 v21, T22 v22, T23 v23, T24 v24) { + return internal::ValueArray24(v1, v2, + v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, + v19, v20, v21, v22, v23, v24); +} + +template +internal::ValueArray25 Values(T1 v1, + T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, + T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, + T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25) { + return internal::ValueArray25(v1, + v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, + v18, v19, v20, v21, v22, v23, v24, v25); +} + +template +internal::ValueArray26 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26) { + return internal::ValueArray26(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, + v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26); +} + +template +internal::ValueArray27 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27) { + return internal::ValueArray27(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, + v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27); +} + +template +internal::ValueArray28 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28) { + return internal::ValueArray28(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, + v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, + v28); +} + +template +internal::ValueArray29 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29) { + return internal::ValueArray29(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, + v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, + v27, v28, v29); +} + +template +internal::ValueArray30 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, + T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, + T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, + T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30) { + return internal::ValueArray30(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, + v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, + v26, v27, v28, v29, v30); +} + +template +internal::ValueArray31 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, + T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, + T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, + T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31) { + return internal::ValueArray31(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, + v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, + v25, v26, v27, v28, v29, v30, v31); +} + +template +internal::ValueArray32 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, + T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, + T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, + T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, + T32 v32) { + return internal::ValueArray32(v1, v2, v3, v4, v5, v6, v7, v8, v9, + v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, + v24, v25, v26, v27, v28, v29, v30, v31, v32); +} + +template +internal::ValueArray33 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, + T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, + T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, + T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, + T32 v32, T33 v33) { + return internal::ValueArray33(v1, v2, v3, v4, v5, v6, v7, v8, + v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, + v24, v25, v26, v27, v28, v29, v30, v31, v32, v33); +} + +template +internal::ValueArray34 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, + T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, + T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, + T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, + T31 v31, T32 v32, T33 v33, T34 v34) { + return internal::ValueArray34(v1, v2, v3, v4, v5, v6, v7, + v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, + v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34); +} + +template +internal::ValueArray35 Values(T1 v1, T2 v2, T3 v3, T4 v4, + T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, + T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, + T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, + T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35) { + return internal::ValueArray35(v1, v2, v3, v4, v5, v6, + v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, + v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35); +} + +template +internal::ValueArray36 Values(T1 v1, T2 v2, T3 v3, T4 v4, + T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, + T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, + T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, + T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36) { + return internal::ValueArray36(v1, v2, v3, v4, + v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, + v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, + v34, v35, v36); +} + +template +internal::ValueArray37 Values(T1 v1, T2 v2, T3 v3, + T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, + T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, + T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, + T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, + T37 v37) { + return internal::ValueArray37(v1, v2, v3, + v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, + v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, + v34, v35, v36, v37); +} + +template +internal::ValueArray38 Values(T1 v1, T2 v2, + T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, + T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, + T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, + T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, + T37 v37, T38 v38) { + return internal::ValueArray38(v1, v2, + v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, + v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, + v33, v34, v35, v36, v37, v38); +} + +template +internal::ValueArray39 Values(T1 v1, T2 v2, + T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, + T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, + T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, + T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, + T37 v37, T38 v38, T39 v39) { + return internal::ValueArray39(v1, + v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, + v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, + v32, v33, v34, v35, v36, v37, v38, v39); +} + +template +internal::ValueArray40 Values(T1 v1, + T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, + T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, + T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, + T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, + T36 v36, T37 v37, T38 v38, T39 v39, T40 v40) { + return internal::ValueArray40(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, + v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, + v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40); +} + +template +internal::ValueArray41 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41) { + return internal::ValueArray41(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, + v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, + v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41); +} + +template +internal::ValueArray42 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42) { + return internal::ValueArray42(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, + v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, + v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, + v42); +} + +template +internal::ValueArray43 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42, T43 v43) { + return internal::ValueArray43(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, + v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, + v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, + v41, v42, v43); +} + +template +internal::ValueArray44 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42, T43 v43, T44 v44) { + return internal::ValueArray44(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, + v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, + v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, + v40, v41, v42, v43, v44); +} + +template +internal::ValueArray45 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, + T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, + T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, + T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, + T33 v33, T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, + T41 v41, T42 v42, T43 v43, T44 v44, T45 v45) { + return internal::ValueArray45(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, + v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, + v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, + v39, v40, v41, v42, v43, v44, v45); +} + +template +internal::ValueArray46 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, + T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, + T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, + T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, + T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, + T40 v40, T41 v41, T42 v42, T43 v43, T44 v44, T45 v45, T46 v46) { + return internal::ValueArray46(v1, v2, v3, v4, v5, v6, v7, v8, v9, + v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, + v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, + v38, v39, v40, v41, v42, v43, v44, v45, v46); +} + +template +internal::ValueArray47 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, + T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, + T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, + T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, + T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, + T40 v40, T41 v41, T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47) { + return internal::ValueArray47(v1, v2, v3, v4, v5, v6, v7, v8, + v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, + v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, + v38, v39, v40, v41, v42, v43, v44, v45, v46, v47); +} + +template +internal::ValueArray48 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, + T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, + T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, + T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, + T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, + T40 v40, T41 v41, T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47, + T48 v48) { + return internal::ValueArray48(v1, v2, v3, v4, v5, v6, v7, + v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, + v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, + v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48); +} + +template +internal::ValueArray49 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, + T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, + T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, + T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, + T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, + T39 v39, T40 v40, T41 v41, T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, + T47 v47, T48 v48, T49 v49) { + return internal::ValueArray49(v1, v2, v3, v4, v5, v6, + v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, + v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, + v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49); +} + +template +internal::ValueArray50 Values(T1 v1, T2 v2, T3 v3, T4 v4, + T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, + T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, + T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, + T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, T37 v37, + T38 v38, T39 v39, T40 v40, T41 v41, T42 v42, T43 v43, T44 v44, T45 v45, + T46 v46, T47 v47, T48 v48, T49 v49, T50 v50) { + return internal::ValueArray50(v1, v2, v3, v4, + v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, + v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, + v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, + v48, v49, v50); +} + +// Bool() allows generating tests with parameters in a set of (false, true). +// +// Synopsis: +// Bool() +// - returns a generator producing sequences with elements {false, true}. +// +// It is useful when testing code that depends on Boolean flags. Combinations +// of multiple flags can be tested when several Bool()'s are combined using +// Combine() function. +// +// In the following example all tests in the test case FlagDependentTest +// will be instantiated twice with parameters false and true. +// +// class FlagDependentTest : public testing::TestWithParam { +// virtual void SetUp() { +// external_flag = GetParam(); +// } +// } +// INSTANTIATE_TEST_CASE_P(BoolSequence, FlagDependentTest, Bool()); +// +inline internal::ParamGenerator Bool() { + return Values(false, true); +} + +# if GTEST_HAS_COMBINE +// Combine() allows the user to combine two or more sequences to produce +// values of a Cartesian product of those sequences' elements. +// +// Synopsis: +// Combine(gen1, gen2, ..., genN) +// - returns a generator producing sequences with elements coming from +// the Cartesian product of elements from the sequences generated by +// gen1, gen2, ..., genN. The sequence elements will have a type of +// tuple where T1, T2, ..., TN are the types +// of elements from sequences produces by gen1, gen2, ..., genN. +// +// Combine can have up to 10 arguments. This number is currently limited +// by the maximum number of elements in the tuple implementation used by Google +// Test. +// +// Example: +// +// This will instantiate tests in test case AnimalTest each one with +// the parameter values tuple("cat", BLACK), tuple("cat", WHITE), +// tuple("dog", BLACK), and tuple("dog", WHITE): +// +// enum Color { BLACK, GRAY, WHITE }; +// class AnimalTest +// : public testing::TestWithParam > {...}; +// +// TEST_P(AnimalTest, AnimalLooksNice) {...} +// +// INSTANTIATE_TEST_CASE_P(AnimalVariations, AnimalTest, +// Combine(Values("cat", "dog"), +// Values(BLACK, WHITE))); +// +// This will instantiate tests in FlagDependentTest with all variations of two +// Boolean flags: +// +// class FlagDependentTest +// : public testing::TestWithParam > { +// virtual void SetUp() { +// // Assigns external_flag_1 and external_flag_2 values from the tuple. +// tie(external_flag_1, external_flag_2) = GetParam(); +// } +// }; +// +// TEST_P(FlagDependentTest, TestFeature1) { +// // Test your code using external_flag_1 and external_flag_2 here. +// } +// INSTANTIATE_TEST_CASE_P(TwoBoolSequence, FlagDependentTest, +// Combine(Bool(), Bool())); +// +template +internal::CartesianProductHolder2 Combine( + const Generator1& g1, const Generator2& g2) { + return internal::CartesianProductHolder2( + g1, g2); +} + +template +internal::CartesianProductHolder3 Combine( + const Generator1& g1, const Generator2& g2, const Generator3& g3) { + return internal::CartesianProductHolder3( + g1, g2, g3); +} + +template +internal::CartesianProductHolder4 Combine( + const Generator1& g1, const Generator2& g2, const Generator3& g3, + const Generator4& g4) { + return internal::CartesianProductHolder4( + g1, g2, g3, g4); +} + +template +internal::CartesianProductHolder5 Combine( + const Generator1& g1, const Generator2& g2, const Generator3& g3, + const Generator4& g4, const Generator5& g5) { + return internal::CartesianProductHolder5( + g1, g2, g3, g4, g5); +} + +template +internal::CartesianProductHolder6 Combine( + const Generator1& g1, const Generator2& g2, const Generator3& g3, + const Generator4& g4, const Generator5& g5, const Generator6& g6) { + return internal::CartesianProductHolder6( + g1, g2, g3, g4, g5, g6); +} + +template +internal::CartesianProductHolder7 Combine( + const Generator1& g1, const Generator2& g2, const Generator3& g3, + const Generator4& g4, const Generator5& g5, const Generator6& g6, + const Generator7& g7) { + return internal::CartesianProductHolder7( + g1, g2, g3, g4, g5, g6, g7); +} + +template +internal::CartesianProductHolder8 Combine( + const Generator1& g1, const Generator2& g2, const Generator3& g3, + const Generator4& g4, const Generator5& g5, const Generator6& g6, + const Generator7& g7, const Generator8& g8) { + return internal::CartesianProductHolder8( + g1, g2, g3, g4, g5, g6, g7, g8); +} + +template +internal::CartesianProductHolder9 Combine( + const Generator1& g1, const Generator2& g2, const Generator3& g3, + const Generator4& g4, const Generator5& g5, const Generator6& g6, + const Generator7& g7, const Generator8& g8, const Generator9& g9) { + return internal::CartesianProductHolder9( + g1, g2, g3, g4, g5, g6, g7, g8, g9); +} + +template +internal::CartesianProductHolder10 Combine( + const Generator1& g1, const Generator2& g2, const Generator3& g3, + const Generator4& g4, const Generator5& g5, const Generator6& g6, + const Generator7& g7, const Generator8& g8, const Generator9& g9, + const Generator10& g10) { + return internal::CartesianProductHolder10( + g1, g2, g3, g4, g5, g6, g7, g8, g9, g10); +} +# endif // GTEST_HAS_COMBINE + + + +# define TEST_P(test_case_name, test_name) \ + class GTEST_TEST_CLASS_NAME_(test_case_name, test_name) \ + : public test_case_name { \ + public: \ + GTEST_TEST_CLASS_NAME_(test_case_name, test_name)() {} \ + virtual void TestBody(); \ + private: \ + static int AddToRegistry() { \ + ::testing::UnitTest::GetInstance()->parameterized_test_registry(). \ + GetTestCasePatternHolder(\ + #test_case_name, __FILE__, __LINE__)->AddTestPattern(\ + #test_case_name, \ + #test_name, \ + new ::testing::internal::TestMetaFactory< \ + GTEST_TEST_CLASS_NAME_(test_case_name, test_name)>()); \ + return 0; \ + } \ + static int gtest_registering_dummy_; \ + GTEST_DISALLOW_COPY_AND_ASSIGN_(\ + GTEST_TEST_CLASS_NAME_(test_case_name, test_name)); \ + }; \ + int GTEST_TEST_CLASS_NAME_(test_case_name, \ + test_name)::gtest_registering_dummy_ = \ + GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::AddToRegistry(); \ + void GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::TestBody() + +# define INSTANTIATE_TEST_CASE_P(prefix, test_case_name, generator) \ + ::testing::internal::ParamGenerator \ + gtest_##prefix##test_case_name##_EvalGenerator_() { return generator; } \ + int gtest_##prefix##test_case_name##_dummy_ = \ + ::testing::UnitTest::GetInstance()->parameterized_test_registry(). \ + GetTestCasePatternHolder(\ + #test_case_name, __FILE__, __LINE__)->AddTestCaseInstantiation(\ + #prefix, \ + >est_##prefix##test_case_name##_EvalGenerator_, \ + __FILE__, __LINE__) + +} // namespace testing + +#endif // GTEST_HAS_PARAM_TEST + +#endif // GTEST_INCLUDE_GTEST_GTEST_PARAM_TEST_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-printers.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-printers.h new file mode 100644 index 0000000000..c59c6af08d --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-printers.h @@ -0,0 +1,796 @@ +// Copyright 2007, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) + +// Google Test - The Google C++ Testing Framework +// +// This file implements a universal value printer that can print a +// value of any type T: +// +// void ::testing::internal::UniversalPrinter::Print(value, ostream_ptr); +// +// A user can teach this function how to print a class type T by +// defining either operator<<() or PrintTo() in the namespace that +// defines T. More specifically, the FIRST defined function in the +// following list will be used (assuming T is defined in namespace +// foo): +// +// 1. foo::PrintTo(const T&, ostream*) +// 2. operator<<(ostream&, const T&) defined in either foo or the +// global namespace. +// +// If none of the above is defined, it will print the debug string of +// the value if it is a protocol buffer, or print the raw bytes in the +// value otherwise. +// +// To aid debugging: when T is a reference type, the address of the +// value is also printed; when T is a (const) char pointer, both the +// pointer value and the NUL-terminated string it points to are +// printed. +// +// We also provide some convenient wrappers: +// +// // Prints a value to a string. For a (const or not) char +// // pointer, the NUL-terminated string (but not the pointer) is +// // printed. +// std::string ::testing::PrintToString(const T& value); +// +// // Prints a value tersely: for a reference type, the referenced +// // value (but not the address) is printed; for a (const or not) char +// // pointer, the NUL-terminated string (but not the pointer) is +// // printed. +// void ::testing::internal::UniversalTersePrint(const T& value, ostream*); +// +// // Prints value using the type inferred by the compiler. The difference +// // from UniversalTersePrint() is that this function prints both the +// // pointer and the NUL-terminated string for a (const or not) char pointer. +// void ::testing::internal::UniversalPrint(const T& value, ostream*); +// +// // Prints the fields of a tuple tersely to a string vector, one +// // element for each field. Tuple support must be enabled in +// // gtest-port.h. +// std::vector UniversalTersePrintTupleFieldsToStrings( +// const Tuple& value); +// +// Known limitation: +// +// The print primitives print the elements of an STL-style container +// using the compiler-inferred type of *iter where iter is a +// const_iterator of the container. When const_iterator is an input +// iterator but not a forward iterator, this inferred type may not +// match value_type, and the print output may be incorrect. In +// practice, this is rarely a problem as for most containers +// const_iterator is a forward iterator. We'll fix this if there's an +// actual need for it. Note that this fix cannot rely on value_type +// being defined as many user-defined container types don't have +// value_type. + +#ifndef GTEST_INCLUDE_GTEST_GTEST_PRINTERS_H_ +#define GTEST_INCLUDE_GTEST_GTEST_PRINTERS_H_ + +#include // NOLINT +#include +#include +#include +#include +#include "gtest/internal/gtest-port.h" +#include "gtest/internal/gtest-internal.h" + +namespace testing { + +// Definitions in the 'internal' and 'internal2' name spaces are +// subject to change without notice. DO NOT USE THEM IN USER CODE! +namespace internal2 { + +// Prints the given number of bytes in the given object to the given +// ostream. +GTEST_API_ void PrintBytesInObjectTo(const unsigned char* obj_bytes, + size_t count, + ::std::ostream* os); + +// For selecting which printer to use when a given type has neither << +// nor PrintTo(). +enum TypeKind { + kProtobuf, // a protobuf type + kConvertibleToInteger, // a type implicitly convertible to BiggestInt + // (e.g. a named or unnamed enum type) + kOtherType // anything else +}; + +// TypeWithoutFormatter::PrintValue(value, os) is called +// by the universal printer to print a value of type T when neither +// operator<< nor PrintTo() is defined for T, where kTypeKind is the +// "kind" of T as defined by enum TypeKind. +template +class TypeWithoutFormatter { + public: + // This default version is called when kTypeKind is kOtherType. + static void PrintValue(const T& value, ::std::ostream* os) { + PrintBytesInObjectTo(reinterpret_cast(&value), + sizeof(value), os); + } +}; + +// We print a protobuf using its ShortDebugString() when the string +// doesn't exceed this many characters; otherwise we print it using +// DebugString() for better readability. +const size_t kProtobufOneLinerMaxLength = 50; + +template +class TypeWithoutFormatter { + public: + static void PrintValue(const T& value, ::std::ostream* os) { + const ::testing::internal::string short_str = value.ShortDebugString(); + const ::testing::internal::string pretty_str = + short_str.length() <= kProtobufOneLinerMaxLength ? + short_str : ("\n" + value.DebugString()); + *os << ("<" + pretty_str + ">"); + } +}; + +template +class TypeWithoutFormatter { + public: + // Since T has no << operator or PrintTo() but can be implicitly + // converted to BiggestInt, we print it as a BiggestInt. + // + // Most likely T is an enum type (either named or unnamed), in which + // case printing it as an integer is the desired behavior. In case + // T is not an enum, printing it as an integer is the best we can do + // given that it has no user-defined printer. + static void PrintValue(const T& value, ::std::ostream* os) { + const internal::BiggestInt kBigInt = value; + *os << kBigInt; + } +}; + +// Prints the given value to the given ostream. If the value is a +// protocol message, its debug string is printed; if it's an enum or +// of a type implicitly convertible to BiggestInt, it's printed as an +// integer; otherwise the bytes in the value are printed. This is +// what UniversalPrinter::Print() does when it knows nothing about +// type T and T has neither << operator nor PrintTo(). +// +// A user can override this behavior for a class type Foo by defining +// a << operator in the namespace where Foo is defined. +// +// We put this operator in namespace 'internal2' instead of 'internal' +// to simplify the implementation, as much code in 'internal' needs to +// use << in STL, which would conflict with our own << were it defined +// in 'internal'. +// +// Note that this operator<< takes a generic std::basic_ostream type instead of the more restricted std::ostream. If +// we define it to take an std::ostream instead, we'll get an +// "ambiguous overloads" compiler error when trying to print a type +// Foo that supports streaming to std::basic_ostream, as the compiler cannot tell whether +// operator<<(std::ostream&, const T&) or +// operator<<(std::basic_stream, const Foo&) is more +// specific. +template +::std::basic_ostream& operator<<( + ::std::basic_ostream& os, const T& x) { + TypeWithoutFormatter::value ? kProtobuf : + internal::ImplicitlyConvertible::value ? + kConvertibleToInteger : kOtherType)>::PrintValue(x, &os); + return os; +} + +} // namespace internal2 +} // namespace testing + +// This namespace MUST NOT BE NESTED IN ::testing, or the name look-up +// magic needed for implementing UniversalPrinter won't work. +namespace testing_internal { + +// Used to print a value that is not an STL-style container when the +// user doesn't define PrintTo() for it. +template +void DefaultPrintNonContainerTo(const T& value, ::std::ostream* os) { + // With the following statement, during unqualified name lookup, + // testing::internal2::operator<< appears as if it was declared in + // the nearest enclosing namespace that contains both + // ::testing_internal and ::testing::internal2, i.e. the global + // namespace. For more details, refer to the C++ Standard section + // 7.3.4-1 [namespace.udir]. This allows us to fall back onto + // testing::internal2::operator<< in case T doesn't come with a << + // operator. + // + // We cannot write 'using ::testing::internal2::operator<<;', which + // gcc 3.3 fails to compile due to a compiler bug. + using namespace ::testing::internal2; // NOLINT + + // Assuming T is defined in namespace foo, in the next statement, + // the compiler will consider all of: + // + // 1. foo::operator<< (thanks to Koenig look-up), + // 2. ::operator<< (as the current namespace is enclosed in ::), + // 3. testing::internal2::operator<< (thanks to the using statement above). + // + // The operator<< whose type matches T best will be picked. + // + // We deliberately allow #2 to be a candidate, as sometimes it's + // impossible to define #1 (e.g. when foo is ::std, defining + // anything in it is undefined behavior unless you are a compiler + // vendor.). + *os << value; +} + +} // namespace testing_internal + +namespace testing { +namespace internal { + +// UniversalPrinter::Print(value, ostream_ptr) prints the given +// value to the given ostream. The caller must ensure that +// 'ostream_ptr' is not NULL, or the behavior is undefined. +// +// We define UniversalPrinter as a class template (as opposed to a +// function template), as we need to partially specialize it for +// reference types, which cannot be done with function templates. +template +class UniversalPrinter; + +template +void UniversalPrint(const T& value, ::std::ostream* os); + +// Used to print an STL-style container when the user doesn't define +// a PrintTo() for it. +template +void DefaultPrintTo(IsContainer /* dummy */, + false_type /* is not a pointer */, + const C& container, ::std::ostream* os) { + const size_t kMaxCount = 32; // The maximum number of elements to print. + *os << '{'; + size_t count = 0; + for (typename C::const_iterator it = container.begin(); + it != container.end(); ++it, ++count) { + if (count > 0) { + *os << ','; + if (count == kMaxCount) { // Enough has been printed. + *os << " ..."; + break; + } + } + *os << ' '; + // We cannot call PrintTo(*it, os) here as PrintTo() doesn't + // handle *it being a native array. + internal::UniversalPrint(*it, os); + } + + if (count > 0) { + *os << ' '; + } + *os << '}'; +} + +// Used to print a pointer that is neither a char pointer nor a member +// pointer, when the user doesn't define PrintTo() for it. (A member +// variable pointer or member function pointer doesn't really point to +// a location in the address space. Their representation is +// implementation-defined. Therefore they will be printed as raw +// bytes.) +template +void DefaultPrintTo(IsNotContainer /* dummy */, + true_type /* is a pointer */, + T* p, ::std::ostream* os) { + if (p == NULL) { + *os << "NULL"; + } else { + // C++ doesn't allow casting from a function pointer to any object + // pointer. + // + // IsTrue() silences warnings: "Condition is always true", + // "unreachable code". + if (IsTrue(ImplicitlyConvertible::value)) { + // T is not a function type. We just call << to print p, + // relying on ADL to pick up user-defined << for their pointer + // types, if any. + *os << p; + } else { + // T is a function type, so '*os << p' doesn't do what we want + // (it just prints p as bool). We want to print p as a const + // void*. However, we cannot cast it to const void* directly, + // even using reinterpret_cast, as earlier versions of gcc + // (e.g. 3.4.5) cannot compile the cast when p is a function + // pointer. Casting to UInt64 first solves the problem. + *os << reinterpret_cast( + reinterpret_cast(p)); + } + } +} + +// Used to print a non-container, non-pointer value when the user +// doesn't define PrintTo() for it. +template +void DefaultPrintTo(IsNotContainer /* dummy */, + false_type /* is not a pointer */, + const T& value, ::std::ostream* os) { + ::testing_internal::DefaultPrintNonContainerTo(value, os); +} + +// Prints the given value using the << operator if it has one; +// otherwise prints the bytes in it. This is what +// UniversalPrinter::Print() does when PrintTo() is not specialized +// or overloaded for type T. +// +// A user can override this behavior for a class type Foo by defining +// an overload of PrintTo() in the namespace where Foo is defined. We +// give the user this option as sometimes defining a << operator for +// Foo is not desirable (e.g. the coding style may prevent doing it, +// or there is already a << operator but it doesn't do what the user +// wants). +template +void PrintTo(const T& value, ::std::ostream* os) { + // DefaultPrintTo() is overloaded. The type of its first two + // arguments determine which version will be picked. If T is an + // STL-style container, the version for container will be called; if + // T is a pointer, the pointer version will be called; otherwise the + // generic version will be called. + // + // Note that we check for container types here, prior to we check + // for protocol message types in our operator<<. The rationale is: + // + // For protocol messages, we want to give people a chance to + // override Google Mock's format by defining a PrintTo() or + // operator<<. For STL containers, other formats can be + // incompatible with Google Mock's format for the container + // elements; therefore we check for container types here to ensure + // that our format is used. + // + // The second argument of DefaultPrintTo() is needed to bypass a bug + // in Symbian's C++ compiler that prevents it from picking the right + // overload between: + // + // PrintTo(const T& x, ...); + // PrintTo(T* x, ...); + DefaultPrintTo(IsContainerTest(0), is_pointer(), value, os); +} + +// The following list of PrintTo() overloads tells +// UniversalPrinter::Print() how to print standard types (built-in +// types, strings, plain arrays, and pointers). + +// Overloads for various char types. +GTEST_API_ void PrintTo(unsigned char c, ::std::ostream* os); +GTEST_API_ void PrintTo(signed char c, ::std::ostream* os); +inline void PrintTo(char c, ::std::ostream* os) { + // When printing a plain char, we always treat it as unsigned. This + // way, the output won't be affected by whether the compiler thinks + // char is signed or not. + PrintTo(static_cast(c), os); +} + +// Overloads for other simple built-in types. +inline void PrintTo(bool x, ::std::ostream* os) { + *os << (x ? "true" : "false"); +} + +// Overload for wchar_t type. +// Prints a wchar_t as a symbol if it is printable or as its internal +// code otherwise and also as its decimal code (except for L'\0'). +// The L'\0' char is printed as "L'\\0'". The decimal code is printed +// as signed integer when wchar_t is implemented by the compiler +// as a signed type and is printed as an unsigned integer when wchar_t +// is implemented as an unsigned type. +GTEST_API_ void PrintTo(wchar_t wc, ::std::ostream* os); + +// Overloads for C strings. +GTEST_API_ void PrintTo(const char* s, ::std::ostream* os); +inline void PrintTo(char* s, ::std::ostream* os) { + PrintTo(ImplicitCast_(s), os); +} + +// signed/unsigned char is often used for representing binary data, so +// we print pointers to it as void* to be safe. +inline void PrintTo(const signed char* s, ::std::ostream* os) { + PrintTo(ImplicitCast_(s), os); +} +inline void PrintTo(signed char* s, ::std::ostream* os) { + PrintTo(ImplicitCast_(s), os); +} +inline void PrintTo(const unsigned char* s, ::std::ostream* os) { + PrintTo(ImplicitCast_(s), os); +} +inline void PrintTo(unsigned char* s, ::std::ostream* os) { + PrintTo(ImplicitCast_(s), os); +} + +// MSVC can be configured to define wchar_t as a typedef of unsigned +// short. It defines _NATIVE_WCHAR_T_DEFINED when wchar_t is a native +// type. When wchar_t is a typedef, defining an overload for const +// wchar_t* would cause unsigned short* be printed as a wide string, +// possibly causing invalid memory accesses. +#if !defined(_MSC_VER) || defined(_NATIVE_WCHAR_T_DEFINED) +// Overloads for wide C strings +GTEST_API_ void PrintTo(const wchar_t* s, ::std::ostream* os); +inline void PrintTo(wchar_t* s, ::std::ostream* os) { + PrintTo(ImplicitCast_(s), os); +} +#endif + +// Overload for C arrays. Multi-dimensional arrays are printed +// properly. + +// Prints the given number of elements in an array, without printing +// the curly braces. +template +void PrintRawArrayTo(const T a[], size_t count, ::std::ostream* os) { + UniversalPrint(a[0], os); + for (size_t i = 1; i != count; i++) { + *os << ", "; + UniversalPrint(a[i], os); + } +} + +// Overloads for ::string and ::std::string. +#if GTEST_HAS_GLOBAL_STRING +GTEST_API_ void PrintStringTo(const ::string&s, ::std::ostream* os); +inline void PrintTo(const ::string& s, ::std::ostream* os) { + PrintStringTo(s, os); +} +#endif // GTEST_HAS_GLOBAL_STRING + +GTEST_API_ void PrintStringTo(const ::std::string&s, ::std::ostream* os); +inline void PrintTo(const ::std::string& s, ::std::ostream* os) { + PrintStringTo(s, os); +} + +// Overloads for ::wstring and ::std::wstring. +#if GTEST_HAS_GLOBAL_WSTRING +GTEST_API_ void PrintWideStringTo(const ::wstring&s, ::std::ostream* os); +inline void PrintTo(const ::wstring& s, ::std::ostream* os) { + PrintWideStringTo(s, os); +} +#endif // GTEST_HAS_GLOBAL_WSTRING + +#if GTEST_HAS_STD_WSTRING +GTEST_API_ void PrintWideStringTo(const ::std::wstring&s, ::std::ostream* os); +inline void PrintTo(const ::std::wstring& s, ::std::ostream* os) { + PrintWideStringTo(s, os); +} +#endif // GTEST_HAS_STD_WSTRING + +#if GTEST_HAS_TR1_TUPLE +// Overload for ::std::tr1::tuple. Needed for printing function arguments, +// which are packed as tuples. + +// Helper function for printing a tuple. T must be instantiated with +// a tuple type. +template +void PrintTupleTo(const T& t, ::std::ostream* os); + +// Overloaded PrintTo() for tuples of various arities. We support +// tuples of up-to 10 fields. The following implementation works +// regardless of whether tr1::tuple is implemented using the +// non-standard variadic template feature or not. + +inline void PrintTo(const ::std::tr1::tuple<>& t, ::std::ostream* os) { + PrintTupleTo(t, os); +} + +template +void PrintTo(const ::std::tr1::tuple& t, ::std::ostream* os) { + PrintTupleTo(t, os); +} + +template +void PrintTo(const ::std::tr1::tuple& t, ::std::ostream* os) { + PrintTupleTo(t, os); +} + +template +void PrintTo(const ::std::tr1::tuple& t, ::std::ostream* os) { + PrintTupleTo(t, os); +} + +template +void PrintTo(const ::std::tr1::tuple& t, ::std::ostream* os) { + PrintTupleTo(t, os); +} + +template +void PrintTo(const ::std::tr1::tuple& t, + ::std::ostream* os) { + PrintTupleTo(t, os); +} + +template +void PrintTo(const ::std::tr1::tuple& t, + ::std::ostream* os) { + PrintTupleTo(t, os); +} + +template +void PrintTo(const ::std::tr1::tuple& t, + ::std::ostream* os) { + PrintTupleTo(t, os); +} + +template +void PrintTo(const ::std::tr1::tuple& t, + ::std::ostream* os) { + PrintTupleTo(t, os); +} + +template +void PrintTo(const ::std::tr1::tuple& t, + ::std::ostream* os) { + PrintTupleTo(t, os); +} + +template +void PrintTo( + const ::std::tr1::tuple& t, + ::std::ostream* os) { + PrintTupleTo(t, os); +} +#endif // GTEST_HAS_TR1_TUPLE + +// Overload for std::pair. +template +void PrintTo(const ::std::pair& value, ::std::ostream* os) { + *os << '('; + // We cannot use UniversalPrint(value.first, os) here, as T1 may be + // a reference type. The same for printing value.second. + UniversalPrinter::Print(value.first, os); + *os << ", "; + UniversalPrinter::Print(value.second, os); + *os << ')'; +} + +// Implements printing a non-reference type T by letting the compiler +// pick the right overload of PrintTo() for T. +template +class UniversalPrinter { + public: + // MSVC warns about adding const to a function type, so we want to + // disable the warning. +#ifdef _MSC_VER +# pragma warning(push) // Saves the current warning state. +# pragma warning(disable:4180) // Temporarily disables warning 4180. +#endif // _MSC_VER + + // Note: we deliberately don't call this PrintTo(), as that name + // conflicts with ::testing::internal::PrintTo in the body of the + // function. + static void Print(const T& value, ::std::ostream* os) { + // By default, ::testing::internal::PrintTo() is used for printing + // the value. + // + // Thanks to Koenig look-up, if T is a class and has its own + // PrintTo() function defined in its namespace, that function will + // be visible here. Since it is more specific than the generic ones + // in ::testing::internal, it will be picked by the compiler in the + // following statement - exactly what we want. + PrintTo(value, os); + } + +#ifdef _MSC_VER +# pragma warning(pop) // Restores the warning state. +#endif // _MSC_VER +}; + +// UniversalPrintArray(begin, len, os) prints an array of 'len' +// elements, starting at address 'begin'. +template +void UniversalPrintArray(const T* begin, size_t len, ::std::ostream* os) { + if (len == 0) { + *os << "{}"; + } else { + *os << "{ "; + const size_t kThreshold = 18; + const size_t kChunkSize = 8; + // If the array has more than kThreshold elements, we'll have to + // omit some details by printing only the first and the last + // kChunkSize elements. + // TODO(wan@google.com): let the user control the threshold using a flag. + if (len <= kThreshold) { + PrintRawArrayTo(begin, len, os); + } else { + PrintRawArrayTo(begin, kChunkSize, os); + *os << ", ..., "; + PrintRawArrayTo(begin + len - kChunkSize, kChunkSize, os); + } + *os << " }"; + } +} +// This overload prints a (const) char array compactly. +GTEST_API_ void UniversalPrintArray(const char* begin, + size_t len, + ::std::ostream* os); + +// Implements printing an array type T[N]. +template +class UniversalPrinter { + public: + // Prints the given array, omitting some elements when there are too + // many. + static void Print(const T (&a)[N], ::std::ostream* os) { + UniversalPrintArray(a, N, os); + } +}; + +// Implements printing a reference type T&. +template +class UniversalPrinter { + public: + // MSVC warns about adding const to a function type, so we want to + // disable the warning. +#ifdef _MSC_VER +# pragma warning(push) // Saves the current warning state. +# pragma warning(disable:4180) // Temporarily disables warning 4180. +#endif // _MSC_VER + + static void Print(const T& value, ::std::ostream* os) { + // Prints the address of the value. We use reinterpret_cast here + // as static_cast doesn't compile when T is a function type. + *os << "@" << reinterpret_cast(&value) << " "; + + // Then prints the value itself. + UniversalPrint(value, os); + } + +#ifdef _MSC_VER +# pragma warning(pop) // Restores the warning state. +#endif // _MSC_VER +}; + +// Prints a value tersely: for a reference type, the referenced value +// (but not the address) is printed; for a (const) char pointer, the +// NUL-terminated string (but not the pointer) is printed. +template +void UniversalTersePrint(const T& value, ::std::ostream* os) { + UniversalPrint(value, os); +} +inline void UniversalTersePrint(const char* str, ::std::ostream* os) { + if (str == NULL) { + *os << "NULL"; + } else { + UniversalPrint(string(str), os); + } +} +inline void UniversalTersePrint(char* str, ::std::ostream* os) { + UniversalTersePrint(static_cast(str), os); +} + +// Prints a value using the type inferred by the compiler. The +// difference between this and UniversalTersePrint() is that for a +// (const) char pointer, this prints both the pointer and the +// NUL-terminated string. +template +void UniversalPrint(const T& value, ::std::ostream* os) { + UniversalPrinter::Print(value, os); +} + +#if GTEST_HAS_TR1_TUPLE +typedef ::std::vector Strings; + +// This helper template allows PrintTo() for tuples and +// UniversalTersePrintTupleFieldsToStrings() to be defined by +// induction on the number of tuple fields. The idea is that +// TuplePrefixPrinter::PrintPrefixTo(t, os) prints the first N +// fields in tuple t, and can be defined in terms of +// TuplePrefixPrinter. + +// The inductive case. +template +struct TuplePrefixPrinter { + // Prints the first N fields of a tuple. + template + static void PrintPrefixTo(const Tuple& t, ::std::ostream* os) { + TuplePrefixPrinter::PrintPrefixTo(t, os); + *os << ", "; + UniversalPrinter::type> + ::Print(::std::tr1::get(t), os); + } + + // Tersely prints the first N fields of a tuple to a string vector, + // one element for each field. + template + static void TersePrintPrefixToStrings(const Tuple& t, Strings* strings) { + TuplePrefixPrinter::TersePrintPrefixToStrings(t, strings); + ::std::stringstream ss; + UniversalTersePrint(::std::tr1::get(t), &ss); + strings->push_back(ss.str()); + } +}; + +// Base cases. +template <> +struct TuplePrefixPrinter<0> { + template + static void PrintPrefixTo(const Tuple&, ::std::ostream*) {} + + template + static void TersePrintPrefixToStrings(const Tuple&, Strings*) {} +}; +// We have to specialize the entire TuplePrefixPrinter<> class +// template here, even though the definition of +// TersePrintPrefixToStrings() is the same as the generic version, as +// Embarcadero (formerly CodeGear, formerly Borland) C++ doesn't +// support specializing a method template of a class template. +template <> +struct TuplePrefixPrinter<1> { + template + static void PrintPrefixTo(const Tuple& t, ::std::ostream* os) { + UniversalPrinter::type>:: + Print(::std::tr1::get<0>(t), os); + } + + template + static void TersePrintPrefixToStrings(const Tuple& t, Strings* strings) { + ::std::stringstream ss; + UniversalTersePrint(::std::tr1::get<0>(t), &ss); + strings->push_back(ss.str()); + } +}; + +// Helper function for printing a tuple. T must be instantiated with +// a tuple type. +template +void PrintTupleTo(const T& t, ::std::ostream* os) { + *os << "("; + TuplePrefixPrinter< ::std::tr1::tuple_size::value>:: + PrintPrefixTo(t, os); + *os << ")"; +} + +// Prints the fields of a tuple tersely to a string vector, one +// element for each field. See the comment before +// UniversalTersePrint() for how we define "tersely". +template +Strings UniversalTersePrintTupleFieldsToStrings(const Tuple& value) { + Strings result; + TuplePrefixPrinter< ::std::tr1::tuple_size::value>:: + TersePrintPrefixToStrings(value, &result); + return result; +} +#endif // GTEST_HAS_TR1_TUPLE + +} // namespace internal + +template +::std::string PrintToString(const T& value) { + ::std::stringstream ss; + internal::UniversalTersePrint(value, &ss); + return ss.str(); +} + +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_GTEST_PRINTERS_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-spi.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-spi.h new file mode 100644 index 0000000000..670fd67ddf --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-spi.h @@ -0,0 +1,232 @@ +// Copyright 2007, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) +// +// Utilities for testing Google Test itself and code that uses Google Test +// (e.g. frameworks built on top of Google Test). + +#ifndef GTEST_INCLUDE_GTEST_GTEST_SPI_H_ +#define GTEST_INCLUDE_GTEST_GTEST_SPI_H_ + +#include "gtest/gtest.h" + +namespace testing { + +// This helper class can be used to mock out Google Test failure reporting +// so that we can test Google Test or code that builds on Google Test. +// +// An object of this class appends a TestPartResult object to the +// TestPartResultArray object given in the constructor whenever a Google Test +// failure is reported. It can either intercept only failures that are +// generated in the same thread that created this object or it can intercept +// all generated failures. The scope of this mock object can be controlled with +// the second argument to the two arguments constructor. +class GTEST_API_ ScopedFakeTestPartResultReporter + : public TestPartResultReporterInterface { + public: + // The two possible mocking modes of this object. + enum InterceptMode { + INTERCEPT_ONLY_CURRENT_THREAD, // Intercepts only thread local failures. + INTERCEPT_ALL_THREADS // Intercepts all failures. + }; + + // The c'tor sets this object as the test part result reporter used + // by Google Test. The 'result' parameter specifies where to report the + // results. This reporter will only catch failures generated in the current + // thread. DEPRECATED + explicit ScopedFakeTestPartResultReporter(TestPartResultArray* result); + + // Same as above, but you can choose the interception scope of this object. + ScopedFakeTestPartResultReporter(InterceptMode intercept_mode, + TestPartResultArray* result); + + // The d'tor restores the previous test part result reporter. + virtual ~ScopedFakeTestPartResultReporter(); + + // Appends the TestPartResult object to the TestPartResultArray + // received in the constructor. + // + // This method is from the TestPartResultReporterInterface + // interface. + virtual void ReportTestPartResult(const TestPartResult& result); + private: + void Init(); + + const InterceptMode intercept_mode_; + TestPartResultReporterInterface* old_reporter_; + TestPartResultArray* const result_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedFakeTestPartResultReporter); +}; + +namespace internal { + +// A helper class for implementing EXPECT_FATAL_FAILURE() and +// EXPECT_NONFATAL_FAILURE(). Its destructor verifies that the given +// TestPartResultArray contains exactly one failure that has the given +// type and contains the given substring. If that's not the case, a +// non-fatal failure will be generated. +class GTEST_API_ SingleFailureChecker { + public: + // The constructor remembers the arguments. + SingleFailureChecker(const TestPartResultArray* results, + TestPartResult::Type type, + const string& substr); + ~SingleFailureChecker(); + private: + const TestPartResultArray* const results_; + const TestPartResult::Type type_; + const string substr_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(SingleFailureChecker); +}; + +} // namespace internal + +} // namespace testing + +// A set of macros for testing Google Test assertions or code that's expected +// to generate Google Test fatal failures. It verifies that the given +// statement will cause exactly one fatal Google Test failure with 'substr' +// being part of the failure message. +// +// There are two different versions of this macro. EXPECT_FATAL_FAILURE only +// affects and considers failures generated in the current thread and +// EXPECT_FATAL_FAILURE_ON_ALL_THREADS does the same but for all threads. +// +// The verification of the assertion is done correctly even when the statement +// throws an exception or aborts the current function. +// +// Known restrictions: +// - 'statement' cannot reference local non-static variables or +// non-static members of the current object. +// - 'statement' cannot return a value. +// - You cannot stream a failure message to this macro. +// +// Note that even though the implementations of the following two +// macros are much alike, we cannot refactor them to use a common +// helper macro, due to some peculiarity in how the preprocessor +// works. The AcceptsMacroThatExpandsToUnprotectedComma test in +// gtest_unittest.cc will fail to compile if we do that. +#define EXPECT_FATAL_FAILURE(statement, substr) \ + do { \ + class GTestExpectFatalFailureHelper {\ + public:\ + static void Execute() { statement; }\ + };\ + ::testing::TestPartResultArray gtest_failures;\ + ::testing::internal::SingleFailureChecker gtest_checker(\ + >est_failures, ::testing::TestPartResult::kFatalFailure, (substr));\ + {\ + ::testing::ScopedFakeTestPartResultReporter gtest_reporter(\ + ::testing::ScopedFakeTestPartResultReporter:: \ + INTERCEPT_ONLY_CURRENT_THREAD, >est_failures);\ + GTestExpectFatalFailureHelper::Execute();\ + }\ + } while (::testing::internal::AlwaysFalse()) + +#define EXPECT_FATAL_FAILURE_ON_ALL_THREADS(statement, substr) \ + do { \ + class GTestExpectFatalFailureHelper {\ + public:\ + static void Execute() { statement; }\ + };\ + ::testing::TestPartResultArray gtest_failures;\ + ::testing::internal::SingleFailureChecker gtest_checker(\ + >est_failures, ::testing::TestPartResult::kFatalFailure, (substr));\ + {\ + ::testing::ScopedFakeTestPartResultReporter gtest_reporter(\ + ::testing::ScopedFakeTestPartResultReporter:: \ + INTERCEPT_ALL_THREADS, >est_failures);\ + GTestExpectFatalFailureHelper::Execute();\ + }\ + } while (::testing::internal::AlwaysFalse()) + +// A macro for testing Google Test assertions or code that's expected to +// generate Google Test non-fatal failures. It asserts that the given +// statement will cause exactly one non-fatal Google Test failure with 'substr' +// being part of the failure message. +// +// There are two different versions of this macro. EXPECT_NONFATAL_FAILURE only +// affects and considers failures generated in the current thread and +// EXPECT_NONFATAL_FAILURE_ON_ALL_THREADS does the same but for all threads. +// +// 'statement' is allowed to reference local variables and members of +// the current object. +// +// The verification of the assertion is done correctly even when the statement +// throws an exception or aborts the current function. +// +// Known restrictions: +// - You cannot stream a failure message to this macro. +// +// Note that even though the implementations of the following two +// macros are much alike, we cannot refactor them to use a common +// helper macro, due to some peculiarity in how the preprocessor +// works. If we do that, the code won't compile when the user gives +// EXPECT_NONFATAL_FAILURE() a statement that contains a macro that +// expands to code containing an unprotected comma. The +// AcceptsMacroThatExpandsToUnprotectedComma test in gtest_unittest.cc +// catches that. +// +// For the same reason, we have to write +// if (::testing::internal::AlwaysTrue()) { statement; } +// instead of +// GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement) +// to avoid an MSVC warning on unreachable code. +#define EXPECT_NONFATAL_FAILURE(statement, substr) \ + do {\ + ::testing::TestPartResultArray gtest_failures;\ + ::testing::internal::SingleFailureChecker gtest_checker(\ + >est_failures, ::testing::TestPartResult::kNonFatalFailure, \ + (substr));\ + {\ + ::testing::ScopedFakeTestPartResultReporter gtest_reporter(\ + ::testing::ScopedFakeTestPartResultReporter:: \ + INTERCEPT_ONLY_CURRENT_THREAD, >est_failures);\ + if (::testing::internal::AlwaysTrue()) { statement; }\ + }\ + } while (::testing::internal::AlwaysFalse()) + +#define EXPECT_NONFATAL_FAILURE_ON_ALL_THREADS(statement, substr) \ + do {\ + ::testing::TestPartResultArray gtest_failures;\ + ::testing::internal::SingleFailureChecker gtest_checker(\ + >est_failures, ::testing::TestPartResult::kNonFatalFailure, \ + (substr));\ + {\ + ::testing::ScopedFakeTestPartResultReporter gtest_reporter(\ + ::testing::ScopedFakeTestPartResultReporter::INTERCEPT_ALL_THREADS,\ + >est_failures);\ + if (::testing::internal::AlwaysTrue()) { statement; }\ + }\ + } while (::testing::internal::AlwaysFalse()) + +#endif // GTEST_INCLUDE_GTEST_GTEST_SPI_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-test-part.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-test-part.h new file mode 100644 index 0000000000..6926d6e4fa --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-test-part.h @@ -0,0 +1,176 @@ +// Copyright 2008, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: mheule@google.com (Markus Heule) +// + +#ifndef GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ +#define GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ + +#include +#include +#include "gtest/internal/gtest-internal.h" +#include "gtest/internal/gtest-string.h" + +namespace testing { + +// A copyable object representing the result of a test part (i.e. an +// assertion or an explicit FAIL(), ADD_FAILURE(), or SUCCESS()). +// +// Don't inherit from TestPartResult as its destructor is not virtual. +class GTEST_API_ TestPartResult { + public: + // The possible outcomes of a test part (i.e. an assertion or an + // explicit SUCCEED(), FAIL(), or ADD_FAILURE()). + enum Type { + kSuccess, // Succeeded. + kNonFatalFailure, // Failed but the test can continue. + kFatalFailure // Failed and the test should be terminated. + }; + + // C'tor. TestPartResult does NOT have a default constructor. + // Always use this constructor (with parameters) to create a + // TestPartResult object. + TestPartResult(Type a_type, + const char* a_file_name, + int a_line_number, + const char* a_message) + : type_(a_type), + file_name_(a_file_name), + line_number_(a_line_number), + summary_(ExtractSummary(a_message)), + message_(a_message) { + } + + // Gets the outcome of the test part. + Type type() const { return type_; } + + // Gets the name of the source file where the test part took place, or + // NULL if it's unknown. + const char* file_name() const { return file_name_.c_str(); } + + // Gets the line in the source file where the test part took place, + // or -1 if it's unknown. + int line_number() const { return line_number_; } + + // Gets the summary of the failure message. + const char* summary() const { return summary_.c_str(); } + + // Gets the message associated with the test part. + const char* message() const { return message_.c_str(); } + + // Returns true iff the test part passed. + bool passed() const { return type_ == kSuccess; } + + // Returns true iff the test part failed. + bool failed() const { return type_ != kSuccess; } + + // Returns true iff the test part non-fatally failed. + bool nonfatally_failed() const { return type_ == kNonFatalFailure; } + + // Returns true iff the test part fatally failed. + bool fatally_failed() const { return type_ == kFatalFailure; } + private: + Type type_; + + // Gets the summary of the failure message by omitting the stack + // trace in it. + static internal::String ExtractSummary(const char* message); + + // The name of the source file where the test part took place, or + // NULL if the source file is unknown. + internal::String file_name_; + // The line in the source file where the test part took place, or -1 + // if the line number is unknown. + int line_number_; + internal::String summary_; // The test failure summary. + internal::String message_; // The test failure message. +}; + +// Prints a TestPartResult object. +std::ostream& operator<<(std::ostream& os, const TestPartResult& result); + +// An array of TestPartResult objects. +// +// Don't inherit from TestPartResultArray as its destructor is not +// virtual. +class GTEST_API_ TestPartResultArray { + public: + TestPartResultArray() {} + + // Appends the given TestPartResult to the array. + void Append(const TestPartResult& result); + + // Returns the TestPartResult at the given index (0-based). + const TestPartResult& GetTestPartResult(int index) const; + + // Returns the number of TestPartResult objects in the array. + int size() const; + + private: + std::vector array_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(TestPartResultArray); +}; + +// This interface knows how to report a test part result. +class TestPartResultReporterInterface { + public: + virtual ~TestPartResultReporterInterface() {} + + virtual void ReportTestPartResult(const TestPartResult& result) = 0; +}; + +namespace internal { + +// This helper class is used by {ASSERT|EXPECT}_NO_FATAL_FAILURE to check if a +// statement generates new fatal failures. To do so it registers itself as the +// current test part result reporter. Besides checking if fatal failures were +// reported, it only delegates the reporting to the former result reporter. +// The original result reporter is restored in the destructor. +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +class GTEST_API_ HasNewFatalFailureHelper + : public TestPartResultReporterInterface { + public: + HasNewFatalFailureHelper(); + virtual ~HasNewFatalFailureHelper(); + virtual void ReportTestPartResult(const TestPartResult& result); + bool has_new_fatal_failure() const { return has_new_fatal_failure_; } + private: + bool has_new_fatal_failure_; + TestPartResultReporterInterface* original_reporter_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(HasNewFatalFailureHelper); +}; + +} // namespace internal + +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-typed-test.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-typed-test.h new file mode 100644 index 0000000000..a34853397b --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest-typed-test.h @@ -0,0 +1,259 @@ +// Copyright 2008 Google Inc. +// All Rights Reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) + +#ifndef GTEST_INCLUDE_GTEST_GTEST_TYPED_TEST_H_ +#define GTEST_INCLUDE_GTEST_GTEST_TYPED_TEST_H_ + +// This header implements typed tests and type-parameterized tests. + +// Typed (aka type-driven) tests repeat the same test for types in a +// list. You must know which types you want to test with when writing +// typed tests. Here's how you do it: + +#if 0 + +// First, define a fixture class template. It should be parameterized +// by a type. Remember to derive it from testing::Test. +template +class FooTest : public testing::Test { + public: + ... + typedef std::list List; + static T shared_; + T value_; +}; + +// Next, associate a list of types with the test case, which will be +// repeated for each type in the list. The typedef is necessary for +// the macro to parse correctly. +typedef testing::Types MyTypes; +TYPED_TEST_CASE(FooTest, MyTypes); + +// If the type list contains only one type, you can write that type +// directly without Types<...>: +// TYPED_TEST_CASE(FooTest, int); + +// Then, use TYPED_TEST() instead of TEST_F() to define as many typed +// tests for this test case as you want. +TYPED_TEST(FooTest, DoesBlah) { + // Inside a test, refer to TypeParam to get the type parameter. + // Since we are inside a derived class template, C++ requires use to + // visit the members of FooTest via 'this'. + TypeParam n = this->value_; + + // To visit static members of the fixture, add the TestFixture:: + // prefix. + n += TestFixture::shared_; + + // To refer to typedefs in the fixture, add the "typename + // TestFixture::" prefix. + typename TestFixture::List values; + values.push_back(n); + ... +} + +TYPED_TEST(FooTest, HasPropertyA) { ... } + +#endif // 0 + +// Type-parameterized tests are abstract test patterns parameterized +// by a type. Compared with typed tests, type-parameterized tests +// allow you to define the test pattern without knowing what the type +// parameters are. The defined pattern can be instantiated with +// different types any number of times, in any number of translation +// units. +// +// If you are designing an interface or concept, you can define a +// suite of type-parameterized tests to verify properties that any +// valid implementation of the interface/concept should have. Then, +// each implementation can easily instantiate the test suite to verify +// that it conforms to the requirements, without having to write +// similar tests repeatedly. Here's an example: + +#if 0 + +// First, define a fixture class template. It should be parameterized +// by a type. Remember to derive it from testing::Test. +template +class FooTest : public testing::Test { + ... +}; + +// Next, declare that you will define a type-parameterized test case +// (the _P suffix is for "parameterized" or "pattern", whichever you +// prefer): +TYPED_TEST_CASE_P(FooTest); + +// Then, use TYPED_TEST_P() to define as many type-parameterized tests +// for this type-parameterized test case as you want. +TYPED_TEST_P(FooTest, DoesBlah) { + // Inside a test, refer to TypeParam to get the type parameter. + TypeParam n = 0; + ... +} + +TYPED_TEST_P(FooTest, HasPropertyA) { ... } + +// Now the tricky part: you need to register all test patterns before +// you can instantiate them. The first argument of the macro is the +// test case name; the rest are the names of the tests in this test +// case. +REGISTER_TYPED_TEST_CASE_P(FooTest, + DoesBlah, HasPropertyA); + +// Finally, you are free to instantiate the pattern with the types you +// want. If you put the above code in a header file, you can #include +// it in multiple C++ source files and instantiate it multiple times. +// +// To distinguish different instances of the pattern, the first +// argument to the INSTANTIATE_* macro is a prefix that will be added +// to the actual test case name. Remember to pick unique prefixes for +// different instances. +typedef testing::Types MyTypes; +INSTANTIATE_TYPED_TEST_CASE_P(My, FooTest, MyTypes); + +// If the type list contains only one type, you can write that type +// directly without Types<...>: +// INSTANTIATE_TYPED_TEST_CASE_P(My, FooTest, int); + +#endif // 0 + +#include "gtest/internal/gtest-port.h" +#include "gtest/internal/gtest-type-util.h" + +// Implements typed tests. + +#if GTEST_HAS_TYPED_TEST + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// Expands to the name of the typedef for the type parameters of the +// given test case. +# define GTEST_TYPE_PARAMS_(TestCaseName) gtest_type_params_##TestCaseName##_ + +// The 'Types' template argument below must have spaces around it +// since some compilers may choke on '>>' when passing a template +// instance (e.g. Types) +# define TYPED_TEST_CASE(CaseName, Types) \ + typedef ::testing::internal::TypeList< Types >::type \ + GTEST_TYPE_PARAMS_(CaseName) + +# define TYPED_TEST(CaseName, TestName) \ + template \ + class GTEST_TEST_CLASS_NAME_(CaseName, TestName) \ + : public CaseName { \ + private: \ + typedef CaseName TestFixture; \ + typedef gtest_TypeParam_ TypeParam; \ + virtual void TestBody(); \ + }; \ + bool gtest_##CaseName##_##TestName##_registered_ GTEST_ATTRIBUTE_UNUSED_ = \ + ::testing::internal::TypeParameterizedTest< \ + CaseName, \ + ::testing::internal::TemplateSel< \ + GTEST_TEST_CLASS_NAME_(CaseName, TestName)>, \ + GTEST_TYPE_PARAMS_(CaseName)>::Register(\ + "", #CaseName, #TestName, 0); \ + template \ + void GTEST_TEST_CLASS_NAME_(CaseName, TestName)::TestBody() + +#endif // GTEST_HAS_TYPED_TEST + +// Implements type-parameterized tests. + +#if GTEST_HAS_TYPED_TEST_P + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// Expands to the namespace name that the type-parameterized tests for +// the given type-parameterized test case are defined in. The exact +// name of the namespace is subject to change without notice. +# define GTEST_CASE_NAMESPACE_(TestCaseName) \ + gtest_case_##TestCaseName##_ + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// Expands to the name of the variable used to remember the names of +// the defined tests in the given test case. +# define GTEST_TYPED_TEST_CASE_P_STATE_(TestCaseName) \ + gtest_typed_test_case_p_state_##TestCaseName##_ + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE DIRECTLY. +// +// Expands to the name of the variable used to remember the names of +// the registered tests in the given test case. +# define GTEST_REGISTERED_TEST_NAMES_(TestCaseName) \ + gtest_registered_test_names_##TestCaseName##_ + +// The variables defined in the type-parameterized test macros are +// static as typically these macros are used in a .h file that can be +// #included in multiple translation units linked together. +# define TYPED_TEST_CASE_P(CaseName) \ + static ::testing::internal::TypedTestCasePState \ + GTEST_TYPED_TEST_CASE_P_STATE_(CaseName) + +# define TYPED_TEST_P(CaseName, TestName) \ + namespace GTEST_CASE_NAMESPACE_(CaseName) { \ + template \ + class TestName : public CaseName { \ + private: \ + typedef CaseName TestFixture; \ + typedef gtest_TypeParam_ TypeParam; \ + virtual void TestBody(); \ + }; \ + static bool gtest_##TestName##_defined_ GTEST_ATTRIBUTE_UNUSED_ = \ + GTEST_TYPED_TEST_CASE_P_STATE_(CaseName).AddTestName(\ + __FILE__, __LINE__, #CaseName, #TestName); \ + } \ + template \ + void GTEST_CASE_NAMESPACE_(CaseName)::TestName::TestBody() + +# define REGISTER_TYPED_TEST_CASE_P(CaseName, ...) \ + namespace GTEST_CASE_NAMESPACE_(CaseName) { \ + typedef ::testing::internal::Templates<__VA_ARGS__>::type gtest_AllTests_; \ + } \ + static const char* const GTEST_REGISTERED_TEST_NAMES_(CaseName) = \ + GTEST_TYPED_TEST_CASE_P_STATE_(CaseName).VerifyRegisteredTestNames(\ + __FILE__, __LINE__, #__VA_ARGS__) + +// The 'Types' template argument below must have spaces around it +// since some compilers may choke on '>>' when passing a template +// instance (e.g. Types) +# define INSTANTIATE_TYPED_TEST_CASE_P(Prefix, CaseName, Types) \ + bool gtest_##Prefix##_##CaseName GTEST_ATTRIBUTE_UNUSED_ = \ + ::testing::internal::TypeParameterizedTestCase::type>::Register(\ + #Prefix, #CaseName, GTEST_REGISTERED_TEST_NAMES_(CaseName)) + +#endif // GTEST_HAS_TYPED_TEST_P + +#endif // GTEST_INCLUDE_GTEST_GTEST_TYPED_TEST_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest.h new file mode 100644 index 0000000000..a66bf7861d --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest.h @@ -0,0 +1,2155 @@ +// Copyright 2005, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) +// +// The Google C++ Testing Framework (Google Test) +// +// This header file defines the public API for Google Test. It should be +// included by any test program that uses Google Test. +// +// IMPORTANT NOTE: Due to limitation of the C++ language, we have to +// leave some internal implementation details in this header file. +// They are clearly marked by comments like this: +// +// // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +// +// Such code is NOT meant to be used by a user directly, and is subject +// to CHANGE WITHOUT NOTICE. Therefore DO NOT DEPEND ON IT in a user +// program! +// +// Acknowledgment: Google Test borrowed the idea of automatic test +// registration from Barthelemy Dagenais' (barthelemy@prologique.com) +// easyUnit framework. + +#ifndef GTEST_INCLUDE_GTEST_GTEST_H_ +#define GTEST_INCLUDE_GTEST_GTEST_H_ + +#include +#include + +#include "gtest/internal/gtest-internal.h" +#include "gtest/internal/gtest-string.h" +#include "gtest/gtest-death-test.h" +#include "gtest/gtest-message.h" +#include "gtest/gtest-param-test.h" +#include "gtest/gtest-printers.h" +#include "gtest/gtest_prod.h" +#include "gtest/gtest-test-part.h" +#include "gtest/gtest-typed-test.h" + +// Depending on the platform, different string classes are available. +// On Linux, in addition to ::std::string, Google also makes use of +// class ::string, which has the same interface as ::std::string, but +// has a different implementation. +// +// The user can define GTEST_HAS_GLOBAL_STRING to 1 to indicate that +// ::string is available AND is a distinct type to ::std::string, or +// define it to 0 to indicate otherwise. +// +// If the user's ::std::string and ::string are the same class due to +// aliasing, he should define GTEST_HAS_GLOBAL_STRING to 0. +// +// If the user doesn't define GTEST_HAS_GLOBAL_STRING, it is defined +// heuristically. + +namespace testing { + +// Declares the flags. + +// This flag temporary enables the disabled tests. +GTEST_DECLARE_bool_(also_run_disabled_tests); + +// This flag brings the debugger on an assertion failure. +GTEST_DECLARE_bool_(break_on_failure); + +// This flag controls whether Google Test catches all test-thrown exceptions +// and logs them as failures. +GTEST_DECLARE_bool_(catch_exceptions); + +// This flag enables using colors in terminal output. Available values are +// "yes" to enable colors, "no" (disable colors), or "auto" (the default) +// to let Google Test decide. +GTEST_DECLARE_string_(color); + +// This flag sets up the filter to select by name using a glob pattern +// the tests to run. If the filter is not given all tests are executed. +GTEST_DECLARE_string_(filter); + +// This flag causes the Google Test to list tests. None of the tests listed +// are actually run if the flag is provided. +GTEST_DECLARE_bool_(list_tests); + +// This flag controls whether Google Test emits a detailed XML report to a file +// in addition to its normal textual output. +GTEST_DECLARE_string_(output); + +// This flags control whether Google Test prints the elapsed time for each +// test. +GTEST_DECLARE_bool_(print_time); + +// This flag specifies the random number seed. +GTEST_DECLARE_int32_(random_seed); + +// This flag sets how many times the tests are repeated. The default value +// is 1. If the value is -1 the tests are repeating forever. +GTEST_DECLARE_int32_(repeat); + +// This flag controls whether Google Test includes Google Test internal +// stack frames in failure stack traces. +GTEST_DECLARE_bool_(show_internal_stack_frames); + +// When this flag is specified, tests' order is randomized on every iteration. +GTEST_DECLARE_bool_(shuffle); + +// This flag specifies the maximum number of stack frames to be +// printed in a failure message. +GTEST_DECLARE_int32_(stack_trace_depth); + +// When this flag is specified, a failed assertion will throw an +// exception if exceptions are enabled, or exit the program with a +// non-zero code otherwise. +GTEST_DECLARE_bool_(throw_on_failure); + +// When this flag is set with a "host:port" string, on supported +// platforms test results are streamed to the specified port on +// the specified host machine. +GTEST_DECLARE_string_(stream_result_to); + +// The upper limit for valid stack trace depths. +const int kMaxStackTraceDepth = 100; + +namespace internal { + +class AssertHelper; +class DefaultGlobalTestPartResultReporter; +class ExecDeathTest; +class NoExecDeathTest; +class FinalSuccessChecker; +class GTestFlagSaver; +class TestResultAccessor; +class TestEventListenersAccessor; +class TestEventRepeater; +class WindowsDeathTest; +class UnitTestImpl* GetUnitTestImpl(); +void ReportFailureInUnknownLocation(TestPartResult::Type result_type, + const String& message); + +// Converts a streamable value to a String. A NULL pointer is +// converted to "(null)". When the input value is a ::string, +// ::std::string, ::wstring, or ::std::wstring object, each NUL +// character in it is replaced with "\\0". +// Declared in gtest-internal.h but defined here, so that it has access +// to the definition of the Message class, required by the ARM +// compiler. +template +String StreamableToString(const T& streamable) { + return (Message() << streamable).GetString(); +} + +} // namespace internal + +// The friend relationship of some of these classes is cyclic. +// If we don't forward declare them the compiler might confuse the classes +// in friendship clauses with same named classes on the scope. +class Test; +class TestCase; +class TestInfo; +class UnitTest; + +// A class for indicating whether an assertion was successful. When +// the assertion wasn't successful, the AssertionResult object +// remembers a non-empty message that describes how it failed. +// +// To create an instance of this class, use one of the factory functions +// (AssertionSuccess() and AssertionFailure()). +// +// This class is useful for two purposes: +// 1. Defining predicate functions to be used with Boolean test assertions +// EXPECT_TRUE/EXPECT_FALSE and their ASSERT_ counterparts +// 2. Defining predicate-format functions to be +// used with predicate assertions (ASSERT_PRED_FORMAT*, etc). +// +// For example, if you define IsEven predicate: +// +// testing::AssertionResult IsEven(int n) { +// if ((n % 2) == 0) +// return testing::AssertionSuccess(); +// else +// return testing::AssertionFailure() << n << " is odd"; +// } +// +// Then the failed expectation EXPECT_TRUE(IsEven(Fib(5))) +// will print the message +// +// Value of: IsEven(Fib(5)) +// Actual: false (5 is odd) +// Expected: true +// +// instead of a more opaque +// +// Value of: IsEven(Fib(5)) +// Actual: false +// Expected: true +// +// in case IsEven is a simple Boolean predicate. +// +// If you expect your predicate to be reused and want to support informative +// messages in EXPECT_FALSE and ASSERT_FALSE (negative assertions show up +// about half as often as positive ones in our tests), supply messages for +// both success and failure cases: +// +// testing::AssertionResult IsEven(int n) { +// if ((n % 2) == 0) +// return testing::AssertionSuccess() << n << " is even"; +// else +// return testing::AssertionFailure() << n << " is odd"; +// } +// +// Then a statement EXPECT_FALSE(IsEven(Fib(6))) will print +// +// Value of: IsEven(Fib(6)) +// Actual: true (8 is even) +// Expected: false +// +// NB: Predicates that support negative Boolean assertions have reduced +// performance in positive ones so be careful not to use them in tests +// that have lots (tens of thousands) of positive Boolean assertions. +// +// To use this class with EXPECT_PRED_FORMAT assertions such as: +// +// // Verifies that Foo() returns an even number. +// EXPECT_PRED_FORMAT1(IsEven, Foo()); +// +// you need to define: +// +// testing::AssertionResult IsEven(const char* expr, int n) { +// if ((n % 2) == 0) +// return testing::AssertionSuccess(); +// else +// return testing::AssertionFailure() +// << "Expected: " << expr << " is even\n Actual: it's " << n; +// } +// +// If Foo() returns 5, you will see the following message: +// +// Expected: Foo() is even +// Actual: it's 5 +// +class GTEST_API_ AssertionResult { + public: + // Copy constructor. + // Used in EXPECT_TRUE/FALSE(assertion_result). + AssertionResult(const AssertionResult& other); + // Used in the EXPECT_TRUE/FALSE(bool_expression). + explicit AssertionResult(bool success) : success_(success) {} + + // Returns true iff the assertion succeeded. + operator bool() const { return success_; } // NOLINT + + // Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE. + AssertionResult operator!() const; + + // Returns the text streamed into this AssertionResult. Test assertions + // use it when they fail (i.e., the predicate's outcome doesn't match the + // assertion's expectation). When nothing has been streamed into the + // object, returns an empty string. + const char* message() const { + return message_.get() != NULL ? message_->c_str() : ""; + } + // TODO(vladl@google.com): Remove this after making sure no clients use it. + // Deprecated; please use message() instead. + const char* failure_message() const { return message(); } + + // Streams a custom failure message into this object. + template AssertionResult& operator<<(const T& value) { + AppendMessage(Message() << value); + return *this; + } + + // Allows streaming basic output manipulators such as endl or flush into + // this object. + AssertionResult& operator<<( + ::std::ostream& (*basic_manipulator)(::std::ostream& stream)) { + AppendMessage(Message() << basic_manipulator); + return *this; + } + + private: + // Appends the contents of message to message_. + void AppendMessage(const Message& a_message) { + if (message_.get() == NULL) + message_.reset(new ::std::string); + message_->append(a_message.GetString().c_str()); + } + + // Stores result of the assertion predicate. + bool success_; + // Stores the message describing the condition in case the expectation + // construct is not satisfied with the predicate's outcome. + // Referenced via a pointer to avoid taking too much stack frame space + // with test assertions. + internal::scoped_ptr< ::std::string> message_; + + GTEST_DISALLOW_ASSIGN_(AssertionResult); +}; + +// Makes a successful assertion result. +GTEST_API_ AssertionResult AssertionSuccess(); + +// Makes a failed assertion result. +GTEST_API_ AssertionResult AssertionFailure(); + +// Makes a failed assertion result with the given failure message. +// Deprecated; use AssertionFailure() << msg. +GTEST_API_ AssertionResult AssertionFailure(const Message& msg); + +// The abstract class that all tests inherit from. +// +// In Google Test, a unit test program contains one or many TestCases, and +// each TestCase contains one or many Tests. +// +// When you define a test using the TEST macro, you don't need to +// explicitly derive from Test - the TEST macro automatically does +// this for you. +// +// The only time you derive from Test is when defining a test fixture +// to be used a TEST_F. For example: +// +// class FooTest : public testing::Test { +// protected: +// virtual void SetUp() { ... } +// virtual void TearDown() { ... } +// ... +// }; +// +// TEST_F(FooTest, Bar) { ... } +// TEST_F(FooTest, Baz) { ... } +// +// Test is not copyable. +class GTEST_API_ Test { + public: + friend class TestInfo; + + // Defines types for pointers to functions that set up and tear down + // a test case. + typedef internal::SetUpTestCaseFunc SetUpTestCaseFunc; + typedef internal::TearDownTestCaseFunc TearDownTestCaseFunc; + + // The d'tor is virtual as we intend to inherit from Test. + virtual ~Test(); + + // Sets up the stuff shared by all tests in this test case. + // + // Google Test will call Foo::SetUpTestCase() before running the first + // test in test case Foo. Hence a sub-class can define its own + // SetUpTestCase() method to shadow the one defined in the super + // class. + static void SetUpTestCase() {} + + // Tears down the stuff shared by all tests in this test case. + // + // Google Test will call Foo::TearDownTestCase() after running the last + // test in test case Foo. Hence a sub-class can define its own + // TearDownTestCase() method to shadow the one defined in the super + // class. + static void TearDownTestCase() {} + + // Returns true iff the current test has a fatal failure. + static bool HasFatalFailure(); + + // Returns true iff the current test has a non-fatal failure. + static bool HasNonfatalFailure(); + + // Returns true iff the current test has a (either fatal or + // non-fatal) failure. + static bool HasFailure() { return HasFatalFailure() || HasNonfatalFailure(); } + + // Logs a property for the current test. Only the last value for a given + // key is remembered. + // These are public static so they can be called from utility functions + // that are not members of the test fixture. + // The arguments are const char* instead strings, as Google Test is used + // on platforms where string doesn't compile. + // + // Note that a driving consideration for these RecordProperty methods + // was to produce xml output suited to the Greenspan charting utility, + // which at present will only chart values that fit in a 32-bit int. It + // is the user's responsibility to restrict their values to 32-bit ints + // if they intend them to be used with Greenspan. + static void RecordProperty(const char* key, const char* value); + static void RecordProperty(const char* key, int value); + + protected: + // Creates a Test object. + Test(); + + // Sets up the test fixture. + virtual void SetUp(); + + // Tears down the test fixture. + virtual void TearDown(); + + private: + // Returns true iff the current test has the same fixture class as + // the first test in the current test case. + static bool HasSameFixtureClass(); + + // Runs the test after the test fixture has been set up. + // + // A sub-class must implement this to define the test logic. + // + // DO NOT OVERRIDE THIS FUNCTION DIRECTLY IN A USER PROGRAM. + // Instead, use the TEST or TEST_F macro. + virtual void TestBody() = 0; + + // Sets up, executes, and tears down the test. + void Run(); + + // Deletes self. We deliberately pick an unusual name for this + // internal method to avoid clashing with names used in user TESTs. + void DeleteSelf_() { delete this; } + + // Uses a GTestFlagSaver to save and restore all Google Test flags. + const internal::GTestFlagSaver* const gtest_flag_saver_; + + // Often a user mis-spells SetUp() as Setup() and spends a long time + // wondering why it is never called by Google Test. The declaration of + // the following method is solely for catching such an error at + // compile time: + // + // - The return type is deliberately chosen to be not void, so it + // will be a conflict if a user declares void Setup() in his test + // fixture. + // + // - This method is private, so it will be another compiler error + // if a user calls it from his test fixture. + // + // DO NOT OVERRIDE THIS FUNCTION. + // + // If you see an error about overriding the following function or + // about it being private, you have mis-spelled SetUp() as Setup(). + struct Setup_should_be_spelled_SetUp {}; + virtual Setup_should_be_spelled_SetUp* Setup() { return NULL; } + + // We disallow copying Tests. + GTEST_DISALLOW_COPY_AND_ASSIGN_(Test); +}; + +typedef internal::TimeInMillis TimeInMillis; + +// A copyable object representing a user specified test property which can be +// output as a key/value string pair. +// +// Don't inherit from TestProperty as its destructor is not virtual. +class TestProperty { + public: + // C'tor. TestProperty does NOT have a default constructor. + // Always use this constructor (with parameters) to create a + // TestProperty object. + TestProperty(const char* a_key, const char* a_value) : + key_(a_key), value_(a_value) { + } + + // Gets the user supplied key. + const char* key() const { + return key_.c_str(); + } + + // Gets the user supplied value. + const char* value() const { + return value_.c_str(); + } + + // Sets a new value, overriding the one supplied in the constructor. + void SetValue(const char* new_value) { + value_ = new_value; + } + + private: + // The key supplied by the user. + internal::String key_; + // The value supplied by the user. + internal::String value_; +}; + +// The result of a single Test. This includes a list of +// TestPartResults, a list of TestProperties, a count of how many +// death tests there are in the Test, and how much time it took to run +// the Test. +// +// TestResult is not copyable. +class GTEST_API_ TestResult { + public: + // Creates an empty TestResult. + TestResult(); + + // D'tor. Do not inherit from TestResult. + ~TestResult(); + + // Gets the number of all test parts. This is the sum of the number + // of successful test parts and the number of failed test parts. + int total_part_count() const; + + // Returns the number of the test properties. + int test_property_count() const; + + // Returns true iff the test passed (i.e. no test part failed). + bool Passed() const { return !Failed(); } + + // Returns true iff the test failed. + bool Failed() const; + + // Returns true iff the test fatally failed. + bool HasFatalFailure() const; + + // Returns true iff the test has a non-fatal failure. + bool HasNonfatalFailure() const; + + // Returns the elapsed time, in milliseconds. + TimeInMillis elapsed_time() const { return elapsed_time_; } + + // Returns the i-th test part result among all the results. i can range + // from 0 to test_property_count() - 1. If i is not in that range, aborts + // the program. + const TestPartResult& GetTestPartResult(int i) const; + + // Returns the i-th test property. i can range from 0 to + // test_property_count() - 1. If i is not in that range, aborts the + // program. + const TestProperty& GetTestProperty(int i) const; + + private: + friend class TestInfo; + friend class UnitTest; + friend class internal::DefaultGlobalTestPartResultReporter; + friend class internal::ExecDeathTest; + friend class internal::TestResultAccessor; + friend class internal::UnitTestImpl; + friend class internal::WindowsDeathTest; + + // Gets the vector of TestPartResults. + const std::vector& test_part_results() const { + return test_part_results_; + } + + // Gets the vector of TestProperties. + const std::vector& test_properties() const { + return test_properties_; + } + + // Sets the elapsed time. + void set_elapsed_time(TimeInMillis elapsed) { elapsed_time_ = elapsed; } + + // Adds a test property to the list. The property is validated and may add + // a non-fatal failure if invalid (e.g., if it conflicts with reserved + // key names). If a property is already recorded for the same key, the + // value will be updated, rather than storing multiple values for the same + // key. + void RecordProperty(const TestProperty& test_property); + + // Adds a failure if the key is a reserved attribute of Google Test + // testcase tags. Returns true if the property is valid. + // TODO(russr): Validate attribute names are legal and human readable. + static bool ValidateTestProperty(const TestProperty& test_property); + + // Adds a test part result to the list. + void AddTestPartResult(const TestPartResult& test_part_result); + + // Returns the death test count. + int death_test_count() const { return death_test_count_; } + + // Increments the death test count, returning the new count. + int increment_death_test_count() { return ++death_test_count_; } + + // Clears the test part results. + void ClearTestPartResults(); + + // Clears the object. + void Clear(); + + // Protects mutable state of the property vector and of owned + // properties, whose values may be updated. + internal::Mutex test_properites_mutex_; + + // The vector of TestPartResults + std::vector test_part_results_; + // The vector of TestProperties + std::vector test_properties_; + // Running count of death tests. + int death_test_count_; + // The elapsed time, in milliseconds. + TimeInMillis elapsed_time_; + + // We disallow copying TestResult. + GTEST_DISALLOW_COPY_AND_ASSIGN_(TestResult); +}; // class TestResult + +// A TestInfo object stores the following information about a test: +// +// Test case name +// Test name +// Whether the test should be run +// A function pointer that creates the test object when invoked +// Test result +// +// The constructor of TestInfo registers itself with the UnitTest +// singleton such that the RUN_ALL_TESTS() macro knows which tests to +// run. +class GTEST_API_ TestInfo { + public: + // Destructs a TestInfo object. This function is not virtual, so + // don't inherit from TestInfo. + ~TestInfo(); + + // Returns the test case name. + const char* test_case_name() const { return test_case_name_.c_str(); } + + // Returns the test name. + const char* name() const { return name_.c_str(); } + + // Returns the name of the parameter type, or NULL if this is not a typed + // or a type-parameterized test. + const char* type_param() const { + if (type_param_.get() != NULL) + return type_param_->c_str(); + return NULL; + } + + // Returns the text representation of the value parameter, or NULL if this + // is not a value-parameterized test. + const char* value_param() const { + if (value_param_.get() != NULL) + return value_param_->c_str(); + return NULL; + } + + // Returns true if this test should run, that is if the test is not disabled + // (or it is disabled but the also_run_disabled_tests flag has been specified) + // and its full name matches the user-specified filter. + // + // Google Test allows the user to filter the tests by their full names. + // The full name of a test Bar in test case Foo is defined as + // "Foo.Bar". Only the tests that match the filter will run. + // + // A filter is a colon-separated list of glob (not regex) patterns, + // optionally followed by a '-' and a colon-separated list of + // negative patterns (tests to exclude). A test is run if it + // matches one of the positive patterns and does not match any of + // the negative patterns. + // + // For example, *A*:Foo.* is a filter that matches any string that + // contains the character 'A' or starts with "Foo.". + bool should_run() const { return should_run_; } + + // Returns the result of the test. + const TestResult* result() const { return &result_; } + + private: + +#if GTEST_HAS_DEATH_TEST + friend class internal::DefaultDeathTestFactory; +#endif // GTEST_HAS_DEATH_TEST + friend class Test; + friend class TestCase; + friend class internal::UnitTestImpl; + friend TestInfo* internal::MakeAndRegisterTestInfo( + const char* test_case_name, const char* name, + const char* type_param, + const char* value_param, + internal::TypeId fixture_class_id, + Test::SetUpTestCaseFunc set_up_tc, + Test::TearDownTestCaseFunc tear_down_tc, + internal::TestFactoryBase* factory); + + // Constructs a TestInfo object. The newly constructed instance assumes + // ownership of the factory object. + TestInfo(const char* test_case_name, const char* name, + const char* a_type_param, + const char* a_value_param, + internal::TypeId fixture_class_id, + internal::TestFactoryBase* factory); + + // Increments the number of death tests encountered in this test so + // far. + int increment_death_test_count() { + return result_.increment_death_test_count(); + } + + // Creates the test object, runs it, records its result, and then + // deletes it. + void Run(); + + static void ClearTestResult(TestInfo* test_info) { + test_info->result_.Clear(); + } + + // These fields are immutable properties of the test. + const std::string test_case_name_; // Test case name + const std::string name_; // Test name + // Name of the parameter type, or NULL if this is not a typed or a + // type-parameterized test. + const internal::scoped_ptr type_param_; + // Text representation of the value parameter, or NULL if this is not a + // value-parameterized test. + const internal::scoped_ptr value_param_; + const internal::TypeId fixture_class_id_; // ID of the test fixture class + bool should_run_; // True iff this test should run + bool is_disabled_; // True iff this test is disabled + bool matches_filter_; // True if this test matches the + // user-specified filter. + internal::TestFactoryBase* const factory_; // The factory that creates + // the test object + + // This field is mutable and needs to be reset before running the + // test for the second time. + TestResult result_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(TestInfo); +}; + +// A test case, which consists of a vector of TestInfos. +// +// TestCase is not copyable. +class GTEST_API_ TestCase { + public: + // Creates a TestCase with the given name. + // + // TestCase does NOT have a default constructor. Always use this + // constructor to create a TestCase object. + // + // Arguments: + // + // name: name of the test case + // a_type_param: the name of the test's type parameter, or NULL if + // this is not a type-parameterized test. + // set_up_tc: pointer to the function that sets up the test case + // tear_down_tc: pointer to the function that tears down the test case + TestCase(const char* name, const char* a_type_param, + Test::SetUpTestCaseFunc set_up_tc, + Test::TearDownTestCaseFunc tear_down_tc); + + // Destructor of TestCase. + virtual ~TestCase(); + + // Gets the name of the TestCase. + const char* name() const { return name_.c_str(); } + + // Returns the name of the parameter type, or NULL if this is not a + // type-parameterized test case. + const char* type_param() const { + if (type_param_.get() != NULL) + return type_param_->c_str(); + return NULL; + } + + // Returns true if any test in this test case should run. + bool should_run() const { return should_run_; } + + // Gets the number of successful tests in this test case. + int successful_test_count() const; + + // Gets the number of failed tests in this test case. + int failed_test_count() const; + + // Gets the number of disabled tests in this test case. + int disabled_test_count() const; + + // Get the number of tests in this test case that should run. + int test_to_run_count() const; + + // Gets the number of all tests in this test case. + int total_test_count() const; + + // Returns true iff the test case passed. + bool Passed() const { return !Failed(); } + + // Returns true iff the test case failed. + bool Failed() const { return failed_test_count() > 0; } + + // Returns the elapsed time, in milliseconds. + TimeInMillis elapsed_time() const { return elapsed_time_; } + + // Returns the i-th test among all the tests. i can range from 0 to + // total_test_count() - 1. If i is not in that range, returns NULL. + const TestInfo* GetTestInfo(int i) const; + + private: + friend class Test; + friend class internal::UnitTestImpl; + + // Gets the (mutable) vector of TestInfos in this TestCase. + std::vector& test_info_list() { return test_info_list_; } + + // Gets the (immutable) vector of TestInfos in this TestCase. + const std::vector& test_info_list() const { + return test_info_list_; + } + + // Returns the i-th test among all the tests. i can range from 0 to + // total_test_count() - 1. If i is not in that range, returns NULL. + TestInfo* GetMutableTestInfo(int i); + + // Sets the should_run member. + void set_should_run(bool should) { should_run_ = should; } + + // Adds a TestInfo to this test case. Will delete the TestInfo upon + // destruction of the TestCase object. + void AddTestInfo(TestInfo * test_info); + + // Clears the results of all tests in this test case. + void ClearResult(); + + // Clears the results of all tests in the given test case. + static void ClearTestCaseResult(TestCase* test_case) { + test_case->ClearResult(); + } + + // Runs every test in this TestCase. + void Run(); + + // Runs SetUpTestCase() for this TestCase. This wrapper is needed + // for catching exceptions thrown from SetUpTestCase(). + void RunSetUpTestCase() { (*set_up_tc_)(); } + + // Runs TearDownTestCase() for this TestCase. This wrapper is + // needed for catching exceptions thrown from TearDownTestCase(). + void RunTearDownTestCase() { (*tear_down_tc_)(); } + + // Returns true iff test passed. + static bool TestPassed(const TestInfo* test_info) { + return test_info->should_run() && test_info->result()->Passed(); + } + + // Returns true iff test failed. + static bool TestFailed(const TestInfo* test_info) { + return test_info->should_run() && test_info->result()->Failed(); + } + + // Returns true iff test is disabled. + static bool TestDisabled(const TestInfo* test_info) { + return test_info->is_disabled_; + } + + // Returns true if the given test should run. + static bool ShouldRunTest(const TestInfo* test_info) { + return test_info->should_run(); + } + + // Shuffles the tests in this test case. + void ShuffleTests(internal::Random* random); + + // Restores the test order to before the first shuffle. + void UnshuffleTests(); + + // Name of the test case. + internal::String name_; + // Name of the parameter type, or NULL if this is not a typed or a + // type-parameterized test. + const internal::scoped_ptr type_param_; + // The vector of TestInfos in their original order. It owns the + // elements in the vector. + std::vector test_info_list_; + // Provides a level of indirection for the test list to allow easy + // shuffling and restoring the test order. The i-th element in this + // vector is the index of the i-th test in the shuffled test list. + std::vector test_indices_; + // Pointer to the function that sets up the test case. + Test::SetUpTestCaseFunc set_up_tc_; + // Pointer to the function that tears down the test case. + Test::TearDownTestCaseFunc tear_down_tc_; + // True iff any test in this test case should run. + bool should_run_; + // Elapsed time, in milliseconds. + TimeInMillis elapsed_time_; + + // We disallow copying TestCases. + GTEST_DISALLOW_COPY_AND_ASSIGN_(TestCase); +}; + +// An Environment object is capable of setting up and tearing down an +// environment. The user should subclass this to define his own +// environment(s). +// +// An Environment object does the set-up and tear-down in virtual +// methods SetUp() and TearDown() instead of the constructor and the +// destructor, as: +// +// 1. You cannot safely throw from a destructor. This is a problem +// as in some cases Google Test is used where exceptions are enabled, and +// we may want to implement ASSERT_* using exceptions where they are +// available. +// 2. You cannot use ASSERT_* directly in a constructor or +// destructor. +class Environment { + public: + // The d'tor is virtual as we need to subclass Environment. + virtual ~Environment() {} + + // Override this to define how to set up the environment. + virtual void SetUp() {} + + // Override this to define how to tear down the environment. + virtual void TearDown() {} + private: + // If you see an error about overriding the following function or + // about it being private, you have mis-spelled SetUp() as Setup(). + struct Setup_should_be_spelled_SetUp {}; + virtual Setup_should_be_spelled_SetUp* Setup() { return NULL; } +}; + +// The interface for tracing execution of tests. The methods are organized in +// the order the corresponding events are fired. +class TestEventListener { + public: + virtual ~TestEventListener() {} + + // Fired before any test activity starts. + virtual void OnTestProgramStart(const UnitTest& unit_test) = 0; + + // Fired before each iteration of tests starts. There may be more than + // one iteration if GTEST_FLAG(repeat) is set. iteration is the iteration + // index, starting from 0. + virtual void OnTestIterationStart(const UnitTest& unit_test, + int iteration) = 0; + + // Fired before environment set-up for each iteration of tests starts. + virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test) = 0; + + // Fired after environment set-up for each iteration of tests ends. + virtual void OnEnvironmentsSetUpEnd(const UnitTest& unit_test) = 0; + + // Fired before the test case starts. + virtual void OnTestCaseStart(const TestCase& test_case) = 0; + + // Fired before the test starts. + virtual void OnTestStart(const TestInfo& test_info) = 0; + + // Fired after a failed assertion or a SUCCEED() invocation. + virtual void OnTestPartResult(const TestPartResult& test_part_result) = 0; + + // Fired after the test ends. + virtual void OnTestEnd(const TestInfo& test_info) = 0; + + // Fired after the test case ends. + virtual void OnTestCaseEnd(const TestCase& test_case) = 0; + + // Fired before environment tear-down for each iteration of tests starts. + virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test) = 0; + + // Fired after environment tear-down for each iteration of tests ends. + virtual void OnEnvironmentsTearDownEnd(const UnitTest& unit_test) = 0; + + // Fired after each iteration of tests finishes. + virtual void OnTestIterationEnd(const UnitTest& unit_test, + int iteration) = 0; + + // Fired after all test activities have ended. + virtual void OnTestProgramEnd(const UnitTest& unit_test) = 0; +}; + +// The convenience class for users who need to override just one or two +// methods and are not concerned that a possible change to a signature of +// the methods they override will not be caught during the build. For +// comments about each method please see the definition of TestEventListener +// above. +class EmptyTestEventListener : public TestEventListener { + public: + virtual void OnTestProgramStart(const UnitTest& /*unit_test*/) {} + virtual void OnTestIterationStart(const UnitTest& /*unit_test*/, + int /*iteration*/) {} + virtual void OnEnvironmentsSetUpStart(const UnitTest& /*unit_test*/) {} + virtual void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) {} + virtual void OnTestCaseStart(const TestCase& /*test_case*/) {} + virtual void OnTestStart(const TestInfo& /*test_info*/) {} + virtual void OnTestPartResult(const TestPartResult& /*test_part_result*/) {} + virtual void OnTestEnd(const TestInfo& /*test_info*/) {} + virtual void OnTestCaseEnd(const TestCase& /*test_case*/) {} + virtual void OnEnvironmentsTearDownStart(const UnitTest& /*unit_test*/) {} + virtual void OnEnvironmentsTearDownEnd(const UnitTest& /*unit_test*/) {} + virtual void OnTestIterationEnd(const UnitTest& /*unit_test*/, + int /*iteration*/) {} + virtual void OnTestProgramEnd(const UnitTest& /*unit_test*/) {} +}; + +// TestEventListeners lets users add listeners to track events in Google Test. +class GTEST_API_ TestEventListeners { + public: + TestEventListeners(); + ~TestEventListeners(); + + // Appends an event listener to the end of the list. Google Test assumes + // the ownership of the listener (i.e. it will delete the listener when + // the test program finishes). + void Append(TestEventListener* listener); + + // Removes the given event listener from the list and returns it. It then + // becomes the caller's responsibility to delete the listener. Returns + // NULL if the listener is not found in the list. + TestEventListener* Release(TestEventListener* listener); + + // Returns the standard listener responsible for the default console + // output. Can be removed from the listeners list to shut down default + // console output. Note that removing this object from the listener list + // with Release transfers its ownership to the caller and makes this + // function return NULL the next time. + TestEventListener* default_result_printer() const { + return default_result_printer_; + } + + // Returns the standard listener responsible for the default XML output + // controlled by the --gtest_output=xml flag. Can be removed from the + // listeners list by users who want to shut down the default XML output + // controlled by this flag and substitute it with custom one. Note that + // removing this object from the listener list with Release transfers its + // ownership to the caller and makes this function return NULL the next + // time. + TestEventListener* default_xml_generator() const { + return default_xml_generator_; + } + + private: + friend class TestCase; + friend class TestInfo; + friend class internal::DefaultGlobalTestPartResultReporter; + friend class internal::NoExecDeathTest; + friend class internal::TestEventListenersAccessor; + friend class internal::UnitTestImpl; + + // Returns repeater that broadcasts the TestEventListener events to all + // subscribers. + TestEventListener* repeater(); + + // Sets the default_result_printer attribute to the provided listener. + // The listener is also added to the listener list and previous + // default_result_printer is removed from it and deleted. The listener can + // also be NULL in which case it will not be added to the list. Does + // nothing if the previous and the current listener objects are the same. + void SetDefaultResultPrinter(TestEventListener* listener); + + // Sets the default_xml_generator attribute to the provided listener. The + // listener is also added to the listener list and previous + // default_xml_generator is removed from it and deleted. The listener can + // also be NULL in which case it will not be added to the list. Does + // nothing if the previous and the current listener objects are the same. + void SetDefaultXmlGenerator(TestEventListener* listener); + + // Controls whether events will be forwarded by the repeater to the + // listeners in the list. + bool EventForwardingEnabled() const; + void SuppressEventForwarding(); + + // The actual list of listeners. + internal::TestEventRepeater* repeater_; + // Listener responsible for the standard result output. + TestEventListener* default_result_printer_; + // Listener responsible for the creation of the XML output file. + TestEventListener* default_xml_generator_; + + // We disallow copying TestEventListeners. + GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventListeners); +}; + +// A UnitTest consists of a vector of TestCases. +// +// This is a singleton class. The only instance of UnitTest is +// created when UnitTest::GetInstance() is first called. This +// instance is never deleted. +// +// UnitTest is not copyable. +// +// This class is thread-safe as long as the methods are called +// according to their specification. +class GTEST_API_ UnitTest { + public: + // Gets the singleton UnitTest object. The first time this method + // is called, a UnitTest object is constructed and returned. + // Consecutive calls will return the same object. + static UnitTest* GetInstance(); + + // Runs all tests in this UnitTest object and prints the result. + // Returns 0 if successful, or 1 otherwise. + // + // This method can only be called from the main thread. + // + // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. + int Run() GTEST_MUST_USE_RESULT_; + + // Returns the working directory when the first TEST() or TEST_F() + // was executed. The UnitTest object owns the string. + const char* original_working_dir() const; + + // Returns the TestCase object for the test that's currently running, + // or NULL if no test is running. + const TestCase* current_test_case() const; + + // Returns the TestInfo object for the test that's currently running, + // or NULL if no test is running. + const TestInfo* current_test_info() const; + + // Returns the random seed used at the start of the current test run. + int random_seed() const; + +#if GTEST_HAS_PARAM_TEST + // Returns the ParameterizedTestCaseRegistry object used to keep track of + // value-parameterized tests and instantiate and register them. + // + // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. + internal::ParameterizedTestCaseRegistry& parameterized_test_registry(); +#endif // GTEST_HAS_PARAM_TEST + + // Gets the number of successful test cases. + int successful_test_case_count() const; + + // Gets the number of failed test cases. + int failed_test_case_count() const; + + // Gets the number of all test cases. + int total_test_case_count() const; + + // Gets the number of all test cases that contain at least one test + // that should run. + int test_case_to_run_count() const; + + // Gets the number of successful tests. + int successful_test_count() const; + + // Gets the number of failed tests. + int failed_test_count() const; + + // Gets the number of disabled tests. + int disabled_test_count() const; + + // Gets the number of all tests. + int total_test_count() const; + + // Gets the number of tests that should run. + int test_to_run_count() const; + + // Gets the elapsed time, in milliseconds. + TimeInMillis elapsed_time() const; + + // Returns true iff the unit test passed (i.e. all test cases passed). + bool Passed() const; + + // Returns true iff the unit test failed (i.e. some test case failed + // or something outside of all tests failed). + bool Failed() const; + + // Gets the i-th test case among all the test cases. i can range from 0 to + // total_test_case_count() - 1. If i is not in that range, returns NULL. + const TestCase* GetTestCase(int i) const; + + // Returns the list of event listeners that can be used to track events + // inside Google Test. + TestEventListeners& listeners(); + + private: + // Registers and returns a global test environment. When a test + // program is run, all global test environments will be set-up in + // the order they were registered. After all tests in the program + // have finished, all global test environments will be torn-down in + // the *reverse* order they were registered. + // + // The UnitTest object takes ownership of the given environment. + // + // This method can only be called from the main thread. + Environment* AddEnvironment(Environment* env); + + // Adds a TestPartResult to the current TestResult object. All + // Google Test assertion macros (e.g. ASSERT_TRUE, EXPECT_EQ, etc) + // eventually call this to report their results. The user code + // should use the assertion macros instead of calling this directly. + void AddTestPartResult(TestPartResult::Type result_type, + const char* file_name, + int line_number, + const internal::String& message, + const internal::String& os_stack_trace); + + // Adds a TestProperty to the current TestResult object. If the result already + // contains a property with the same key, the value will be updated. + void RecordPropertyForCurrentTest(const char* key, const char* value); + + // Gets the i-th test case among all the test cases. i can range from 0 to + // total_test_case_count() - 1. If i is not in that range, returns NULL. + TestCase* GetMutableTestCase(int i); + + // Accessors for the implementation object. + internal::UnitTestImpl* impl() { return impl_; } + const internal::UnitTestImpl* impl() const { return impl_; } + + // These classes and funcions are friends as they need to access private + // members of UnitTest. + friend class Test; + friend class internal::AssertHelper; + friend class internal::ScopedTrace; + friend Environment* AddGlobalTestEnvironment(Environment* env); + friend internal::UnitTestImpl* internal::GetUnitTestImpl(); + friend void internal::ReportFailureInUnknownLocation( + TestPartResult::Type result_type, + const internal::String& message); + + // Creates an empty UnitTest. + UnitTest(); + + // D'tor + virtual ~UnitTest(); + + // Pushes a trace defined by SCOPED_TRACE() on to the per-thread + // Google Test trace stack. + void PushGTestTrace(const internal::TraceInfo& trace); + + // Pops a trace from the per-thread Google Test trace stack. + void PopGTestTrace(); + + // Protects mutable state in *impl_. This is mutable as some const + // methods need to lock it too. + mutable internal::Mutex mutex_; + + // Opaque implementation object. This field is never changed once + // the object is constructed. We don't mark it as const here, as + // doing so will cause a warning in the constructor of UnitTest. + // Mutable state in *impl_ is protected by mutex_. + internal::UnitTestImpl* impl_; + + // We disallow copying UnitTest. + GTEST_DISALLOW_COPY_AND_ASSIGN_(UnitTest); +}; + +// A convenient wrapper for adding an environment for the test +// program. +// +// You should call this before RUN_ALL_TESTS() is called, probably in +// main(). If you use gtest_main, you need to call this before main() +// starts for it to take effect. For example, you can define a global +// variable like this: +// +// testing::Environment* const foo_env = +// testing::AddGlobalTestEnvironment(new FooEnvironment); +// +// However, we strongly recommend you to write your own main() and +// call AddGlobalTestEnvironment() there, as relying on initialization +// of global variables makes the code harder to read and may cause +// problems when you register multiple environments from different +// translation units and the environments have dependencies among them +// (remember that the compiler doesn't guarantee the order in which +// global variables from different translation units are initialized). +inline Environment* AddGlobalTestEnvironment(Environment* env) { + return UnitTest::GetInstance()->AddEnvironment(env); +} + +// Initializes Google Test. This must be called before calling +// RUN_ALL_TESTS(). In particular, it parses a command line for the +// flags that Google Test recognizes. Whenever a Google Test flag is +// seen, it is removed from argv, and *argc is decremented. +// +// No value is returned. Instead, the Google Test flag variables are +// updated. +// +// Calling the function for the second time has no user-visible effect. +GTEST_API_ void InitGoogleTest(int* argc, char** argv); + +// This overloaded version can be used in Windows programs compiled in +// UNICODE mode. +GTEST_API_ void InitGoogleTest(int* argc, wchar_t** argv); + +namespace internal { + +// Formats a comparison assertion (e.g. ASSERT_EQ, EXPECT_LT, and etc) +// operand to be used in a failure message. The type (but not value) +// of the other operand may affect the format. This allows us to +// print a char* as a raw pointer when it is compared against another +// char*, and print it as a C string when it is compared against an +// std::string object, for example. +// +// The default implementation ignores the type of the other operand. +// Some specialized versions are used to handle formatting wide or +// narrow C strings. +// +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +template +String FormatForComparisonFailureMessage(const T1& value, + const T2& /* other_operand */) { + // C++Builder compiles this incorrectly if the namespace isn't explicitly + // given. + return ::testing::PrintToString(value); +} + +// The helper function for {ASSERT|EXPECT}_EQ. +template +AssertionResult CmpHelperEQ(const char* expected_expression, + const char* actual_expression, + const T1& expected, + const T2& actual) { +#ifdef _MSC_VER +# pragma warning(push) // Saves the current warning state. +# pragma warning(disable:4389) // Temporarily disables warning on + // signed/unsigned mismatch. +#endif + + if (expected == actual) { + return AssertionSuccess(); + } + +#ifdef _MSC_VER +# pragma warning(pop) // Restores the warning state. +#endif + + return EqFailure(expected_expression, + actual_expression, + FormatForComparisonFailureMessage(expected, actual), + FormatForComparisonFailureMessage(actual, expected), + false); +} + +// With this overloaded version, we allow anonymous enums to be used +// in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous enums +// can be implicitly cast to BiggestInt. +GTEST_API_ AssertionResult CmpHelperEQ(const char* expected_expression, + const char* actual_expression, + BiggestInt expected, + BiggestInt actual); + +// The helper class for {ASSERT|EXPECT}_EQ. The template argument +// lhs_is_null_literal is true iff the first argument to ASSERT_EQ() +// is a null pointer literal. The following default implementation is +// for lhs_is_null_literal being false. +template +class EqHelper { + public: + // This templatized version is for the general case. + template + static AssertionResult Compare(const char* expected_expression, + const char* actual_expression, + const T1& expected, + const T2& actual) { + return CmpHelperEQ(expected_expression, actual_expression, expected, + actual); + } + + // With this overloaded version, we allow anonymous enums to be used + // in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous + // enums can be implicitly cast to BiggestInt. + // + // Even though its body looks the same as the above version, we + // cannot merge the two, as it will make anonymous enums unhappy. + static AssertionResult Compare(const char* expected_expression, + const char* actual_expression, + BiggestInt expected, + BiggestInt actual) { + return CmpHelperEQ(expected_expression, actual_expression, expected, + actual); + } +}; + +// This specialization is used when the first argument to ASSERT_EQ() +// is a null pointer literal, like NULL, false, or 0. +template <> +class EqHelper { + public: + // We define two overloaded versions of Compare(). The first + // version will be picked when the second argument to ASSERT_EQ() is + // NOT a pointer, e.g. ASSERT_EQ(0, AnIntFunction()) or + // EXPECT_EQ(false, a_bool). + template + static AssertionResult Compare( + const char* expected_expression, + const char* actual_expression, + const T1& expected, + const T2& actual, + // The following line prevents this overload from being considered if T2 + // is not a pointer type. We need this because ASSERT_EQ(NULL, my_ptr) + // expands to Compare("", "", NULL, my_ptr), which requires a conversion + // to match the Secret* in the other overload, which would otherwise make + // this template match better. + typename EnableIf::value>::type* = 0) { + return CmpHelperEQ(expected_expression, actual_expression, expected, + actual); + } + + // This version will be picked when the second argument to ASSERT_EQ() is a + // pointer, e.g. ASSERT_EQ(NULL, a_pointer). + template + static AssertionResult Compare( + const char* expected_expression, + const char* actual_expression, + // We used to have a second template parameter instead of Secret*. That + // template parameter would deduce to 'long', making this a better match + // than the first overload even without the first overload's EnableIf. + // Unfortunately, gcc with -Wconversion-null warns when "passing NULL to + // non-pointer argument" (even a deduced integral argument), so the old + // implementation caused warnings in user code. + Secret* /* expected (NULL) */, + T* actual) { + // We already know that 'expected' is a null pointer. + return CmpHelperEQ(expected_expression, actual_expression, + static_cast(NULL), actual); + } +}; + +// A macro for implementing the helper functions needed to implement +// ASSERT_?? and EXPECT_??. It is here just to avoid copy-and-paste +// of similar code. +// +// For each templatized helper function, we also define an overloaded +// version for BiggestInt in order to reduce code bloat and allow +// anonymous enums to be used with {ASSERT|EXPECT}_?? when compiled +// with gcc 4. +// +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +#define GTEST_IMPL_CMP_HELPER_(op_name, op)\ +template \ +AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \ + const T1& val1, const T2& val2) {\ + if (val1 op val2) {\ + return AssertionSuccess();\ + } else {\ + return AssertionFailure() \ + << "Expected: (" << expr1 << ") " #op " (" << expr2\ + << "), actual: " << FormatForComparisonFailureMessage(val1, val2)\ + << " vs " << FormatForComparisonFailureMessage(val2, val1);\ + }\ +}\ +GTEST_API_ AssertionResult CmpHelper##op_name(\ + const char* expr1, const char* expr2, BiggestInt val1, BiggestInt val2) + +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. + +// Implements the helper function for {ASSERT|EXPECT}_NE +GTEST_IMPL_CMP_HELPER_(NE, !=); +// Implements the helper function for {ASSERT|EXPECT}_LE +GTEST_IMPL_CMP_HELPER_(LE, <=); +// Implements the helper function for {ASSERT|EXPECT}_LT +GTEST_IMPL_CMP_HELPER_(LT, < ); +// Implements the helper function for {ASSERT|EXPECT}_GE +GTEST_IMPL_CMP_HELPER_(GE, >=); +// Implements the helper function for {ASSERT|EXPECT}_GT +GTEST_IMPL_CMP_HELPER_(GT, > ); + +#undef GTEST_IMPL_CMP_HELPER_ + +// The helper function for {ASSERT|EXPECT}_STREQ. +// +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +GTEST_API_ AssertionResult CmpHelperSTREQ(const char* expected_expression, + const char* actual_expression, + const char* expected, + const char* actual); + +// The helper function for {ASSERT|EXPECT}_STRCASEEQ. +// +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +GTEST_API_ AssertionResult CmpHelperSTRCASEEQ(const char* expected_expression, + const char* actual_expression, + const char* expected, + const char* actual); + +// The helper function for {ASSERT|EXPECT}_STRNE. +// +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +GTEST_API_ AssertionResult CmpHelperSTRNE(const char* s1_expression, + const char* s2_expression, + const char* s1, + const char* s2); + +// The helper function for {ASSERT|EXPECT}_STRCASENE. +// +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +GTEST_API_ AssertionResult CmpHelperSTRCASENE(const char* s1_expression, + const char* s2_expression, + const char* s1, + const char* s2); + + +// Helper function for *_STREQ on wide strings. +// +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +GTEST_API_ AssertionResult CmpHelperSTREQ(const char* expected_expression, + const char* actual_expression, + const wchar_t* expected, + const wchar_t* actual); + +// Helper function for *_STRNE on wide strings. +// +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +GTEST_API_ AssertionResult CmpHelperSTRNE(const char* s1_expression, + const char* s2_expression, + const wchar_t* s1, + const wchar_t* s2); + +} // namespace internal + +// IsSubstring() and IsNotSubstring() are intended to be used as the +// first argument to {EXPECT,ASSERT}_PRED_FORMAT2(), not by +// themselves. They check whether needle is a substring of haystack +// (NULL is considered a substring of itself only), and return an +// appropriate error message when they fail. +// +// The {needle,haystack}_expr arguments are the stringified +// expressions that generated the two real arguments. +GTEST_API_ AssertionResult IsSubstring( + const char* needle_expr, const char* haystack_expr, + const char* needle, const char* haystack); +GTEST_API_ AssertionResult IsSubstring( + const char* needle_expr, const char* haystack_expr, + const wchar_t* needle, const wchar_t* haystack); +GTEST_API_ AssertionResult IsNotSubstring( + const char* needle_expr, const char* haystack_expr, + const char* needle, const char* haystack); +GTEST_API_ AssertionResult IsNotSubstring( + const char* needle_expr, const char* haystack_expr, + const wchar_t* needle, const wchar_t* haystack); +GTEST_API_ AssertionResult IsSubstring( + const char* needle_expr, const char* haystack_expr, + const ::std::string& needle, const ::std::string& haystack); +GTEST_API_ AssertionResult IsNotSubstring( + const char* needle_expr, const char* haystack_expr, + const ::std::string& needle, const ::std::string& haystack); + +#if GTEST_HAS_STD_WSTRING +GTEST_API_ AssertionResult IsSubstring( + const char* needle_expr, const char* haystack_expr, + const ::std::wstring& needle, const ::std::wstring& haystack); +GTEST_API_ AssertionResult IsNotSubstring( + const char* needle_expr, const char* haystack_expr, + const ::std::wstring& needle, const ::std::wstring& haystack); +#endif // GTEST_HAS_STD_WSTRING + +namespace internal { + +// Helper template function for comparing floating-points. +// +// Template parameter: +// +// RawType: the raw floating-point type (either float or double) +// +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +template +AssertionResult CmpHelperFloatingPointEQ(const char* expected_expression, + const char* actual_expression, + RawType expected, + RawType actual) { + const FloatingPoint lhs(expected), rhs(actual); + + if (lhs.AlmostEquals(rhs)) { + return AssertionSuccess(); + } + + ::std::stringstream expected_ss; + expected_ss << std::setprecision(std::numeric_limits::digits10 + 2) + << expected; + + ::std::stringstream actual_ss; + actual_ss << std::setprecision(std::numeric_limits::digits10 + 2) + << actual; + + return EqFailure(expected_expression, + actual_expression, + StringStreamToString(&expected_ss), + StringStreamToString(&actual_ss), + false); +} + +// Helper function for implementing ASSERT_NEAR. +// +// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM. +GTEST_API_ AssertionResult DoubleNearPredFormat(const char* expr1, + const char* expr2, + const char* abs_error_expr, + double val1, + double val2, + double abs_error); + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// A class that enables one to stream messages to assertion macros +class GTEST_API_ AssertHelper { + public: + // Constructor. + AssertHelper(TestPartResult::Type type, + const char* file, + int line, + const char* message); + ~AssertHelper(); + + // Message assignment is a semantic trick to enable assertion + // streaming; see the GTEST_MESSAGE_ macro below. + void operator=(const Message& message) const; + + private: + // We put our data in a struct so that the size of the AssertHelper class can + // be as small as possible. This is important because gcc is incapable of + // re-using stack space even for temporary variables, so every EXPECT_EQ + // reserves stack space for another AssertHelper. + struct AssertHelperData { + AssertHelperData(TestPartResult::Type t, + const char* srcfile, + int line_num, + const char* msg) + : type(t), file(srcfile), line(line_num), message(msg) { } + + TestPartResult::Type const type; + const char* const file; + int const line; + String const message; + + private: + GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelperData); + }; + + AssertHelperData* const data_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelper); +}; + +} // namespace internal + +#if GTEST_HAS_PARAM_TEST +// The pure interface class that all value-parameterized tests inherit from. +// A value-parameterized class must inherit from both ::testing::Test and +// ::testing::WithParamInterface. In most cases that just means inheriting +// from ::testing::TestWithParam, but more complicated test hierarchies +// may need to inherit from Test and WithParamInterface at different levels. +// +// This interface has support for accessing the test parameter value via +// the GetParam() method. +// +// Use it with one of the parameter generator defining functions, like Range(), +// Values(), ValuesIn(), Bool(), and Combine(). +// +// class FooTest : public ::testing::TestWithParam { +// protected: +// FooTest() { +// // Can use GetParam() here. +// } +// virtual ~FooTest() { +// // Can use GetParam() here. +// } +// virtual void SetUp() { +// // Can use GetParam() here. +// } +// virtual void TearDown { +// // Can use GetParam() here. +// } +// }; +// TEST_P(FooTest, DoesBar) { +// // Can use GetParam() method here. +// Foo foo; +// ASSERT_TRUE(foo.DoesBar(GetParam())); +// } +// INSTANTIATE_TEST_CASE_P(OneToTenRange, FooTest, ::testing::Range(1, 10)); + +template +class WithParamInterface { + public: + typedef T ParamType; + virtual ~WithParamInterface() {} + + // The current parameter value. Is also available in the test fixture's + // constructor. This member function is non-static, even though it only + // references static data, to reduce the opportunity for incorrect uses + // like writing 'WithParamInterface::GetParam()' for a test that + // uses a fixture whose parameter type is int. + const ParamType& GetParam() const { return *parameter_; } + + private: + // Sets parameter value. The caller is responsible for making sure the value + // remains alive and unchanged throughout the current test. + static void SetParam(const ParamType* parameter) { + parameter_ = parameter; + } + + // Static value used for accessing parameter during a test lifetime. + static const ParamType* parameter_; + + // TestClass must be a subclass of WithParamInterface and Test. + template friend class internal::ParameterizedTestFactory; +}; + +template +const T* WithParamInterface::parameter_ = NULL; + +// Most value-parameterized classes can ignore the existence of +// WithParamInterface, and can just inherit from ::testing::TestWithParam. + +template +class TestWithParam : public Test, public WithParamInterface { +}; + +#endif // GTEST_HAS_PARAM_TEST + +// Macros for indicating success/failure in test code. + +// ADD_FAILURE unconditionally adds a failure to the current test. +// SUCCEED generates a success - it doesn't automatically make the +// current test successful, as a test is only successful when it has +// no failure. +// +// EXPECT_* verifies that a certain condition is satisfied. If not, +// it behaves like ADD_FAILURE. In particular: +// +// EXPECT_TRUE verifies that a Boolean condition is true. +// EXPECT_FALSE verifies that a Boolean condition is false. +// +// FAIL and ASSERT_* are similar to ADD_FAILURE and EXPECT_*, except +// that they will also abort the current function on failure. People +// usually want the fail-fast behavior of FAIL and ASSERT_*, but those +// writing data-driven tests often find themselves using ADD_FAILURE +// and EXPECT_* more. +// +// Examples: +// +// EXPECT_TRUE(server.StatusIsOK()); +// ASSERT_FALSE(server.HasPendingRequest(port)) +// << "There are still pending requests " << "on port " << port; + +// Generates a nonfatal failure with a generic message. +#define ADD_FAILURE() GTEST_NONFATAL_FAILURE_("Failed") + +// Generates a nonfatal failure at the given source file location with +// a generic message. +#define ADD_FAILURE_AT(file, line) \ + GTEST_MESSAGE_AT_(file, line, "Failed", \ + ::testing::TestPartResult::kNonFatalFailure) + +// Generates a fatal failure with a generic message. +#define GTEST_FAIL() GTEST_FATAL_FAILURE_("Failed") + +// Define this macro to 1 to omit the definition of FAIL(), which is a +// generic name and clashes with some other libraries. +#if !GTEST_DONT_DEFINE_FAIL +# define FAIL() GTEST_FAIL() +#endif + +// Generates a success with a generic message. +#define GTEST_SUCCEED() GTEST_SUCCESS_("Succeeded") + +// Define this macro to 1 to omit the definition of SUCCEED(), which +// is a generic name and clashes with some other libraries. +#if !GTEST_DONT_DEFINE_SUCCEED +# define SUCCEED() GTEST_SUCCEED() +#endif + +// Macros for testing exceptions. +// +// * {ASSERT|EXPECT}_THROW(statement, expected_exception): +// Tests that the statement throws the expected exception. +// * {ASSERT|EXPECT}_NO_THROW(statement): +// Tests that the statement doesn't throw any exception. +// * {ASSERT|EXPECT}_ANY_THROW(statement): +// Tests that the statement throws an exception. + +#define EXPECT_THROW(statement, expected_exception) \ + GTEST_TEST_THROW_(statement, expected_exception, GTEST_NONFATAL_FAILURE_) +#define EXPECT_NO_THROW(statement) \ + GTEST_TEST_NO_THROW_(statement, GTEST_NONFATAL_FAILURE_) +#define EXPECT_ANY_THROW(statement) \ + GTEST_TEST_ANY_THROW_(statement, GTEST_NONFATAL_FAILURE_) +#define ASSERT_THROW(statement, expected_exception) \ + GTEST_TEST_THROW_(statement, expected_exception, GTEST_FATAL_FAILURE_) +#define ASSERT_NO_THROW(statement) \ + GTEST_TEST_NO_THROW_(statement, GTEST_FATAL_FAILURE_) +#define ASSERT_ANY_THROW(statement) \ + GTEST_TEST_ANY_THROW_(statement, GTEST_FATAL_FAILURE_) + +// Boolean assertions. Condition can be either a Boolean expression or an +// AssertionResult. For more information on how to use AssertionResult with +// these macros see comments on that class. +#define EXPECT_TRUE(condition) \ + GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \ + GTEST_NONFATAL_FAILURE_) +#define EXPECT_FALSE(condition) \ + GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \ + GTEST_NONFATAL_FAILURE_) +#define ASSERT_TRUE(condition) \ + GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \ + GTEST_FATAL_FAILURE_) +#define ASSERT_FALSE(condition) \ + GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \ + GTEST_FATAL_FAILURE_) + +// Includes the auto-generated header that implements a family of +// generic predicate assertion macros. +#include "gtest/gtest_pred_impl.h" + +// Macros for testing equalities and inequalities. +// +// * {ASSERT|EXPECT}_EQ(expected, actual): Tests that expected == actual +// * {ASSERT|EXPECT}_NE(v1, v2): Tests that v1 != v2 +// * {ASSERT|EXPECT}_LT(v1, v2): Tests that v1 < v2 +// * {ASSERT|EXPECT}_LE(v1, v2): Tests that v1 <= v2 +// * {ASSERT|EXPECT}_GT(v1, v2): Tests that v1 > v2 +// * {ASSERT|EXPECT}_GE(v1, v2): Tests that v1 >= v2 +// +// When they are not, Google Test prints both the tested expressions and +// their actual values. The values must be compatible built-in types, +// or you will get a compiler error. By "compatible" we mean that the +// values can be compared by the respective operator. +// +// Note: +// +// 1. It is possible to make a user-defined type work with +// {ASSERT|EXPECT}_??(), but that requires overloading the +// comparison operators and is thus discouraged by the Google C++ +// Usage Guide. Therefore, you are advised to use the +// {ASSERT|EXPECT}_TRUE() macro to assert that two objects are +// equal. +// +// 2. The {ASSERT|EXPECT}_??() macros do pointer comparisons on +// pointers (in particular, C strings). Therefore, if you use it +// with two C strings, you are testing how their locations in memory +// are related, not how their content is related. To compare two C +// strings by content, use {ASSERT|EXPECT}_STR*(). +// +// 3. {ASSERT|EXPECT}_EQ(expected, actual) is preferred to +// {ASSERT|EXPECT}_TRUE(expected == actual), as the former tells you +// what the actual value is when it fails, and similarly for the +// other comparisons. +// +// 4. Do not depend on the order in which {ASSERT|EXPECT}_??() +// evaluate their arguments, which is undefined. +// +// 5. These macros evaluate their arguments exactly once. +// +// Examples: +// +// EXPECT_NE(5, Foo()); +// EXPECT_EQ(NULL, a_pointer); +// ASSERT_LT(i, array_size); +// ASSERT_GT(records.size(), 0) << "There is no record left."; + +#define EXPECT_EQ(expected, actual) \ + EXPECT_PRED_FORMAT2(::testing::internal:: \ + EqHelper::Compare, \ + expected, actual) +#define EXPECT_NE(expected, actual) \ + EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperNE, expected, actual) +#define EXPECT_LE(val1, val2) \ + EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2) +#define EXPECT_LT(val1, val2) \ + EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2) +#define EXPECT_GE(val1, val2) \ + EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2) +#define EXPECT_GT(val1, val2) \ + EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2) + +#define GTEST_ASSERT_EQ(expected, actual) \ + ASSERT_PRED_FORMAT2(::testing::internal:: \ + EqHelper::Compare, \ + expected, actual) +#define GTEST_ASSERT_NE(val1, val2) \ + ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperNE, val1, val2) +#define GTEST_ASSERT_LE(val1, val2) \ + ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2) +#define GTEST_ASSERT_LT(val1, val2) \ + ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2) +#define GTEST_ASSERT_GE(val1, val2) \ + ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2) +#define GTEST_ASSERT_GT(val1, val2) \ + ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2) + +// Define macro GTEST_DONT_DEFINE_ASSERT_XY to 1 to omit the definition of +// ASSERT_XY(), which clashes with some users' own code. + +#if !GTEST_DONT_DEFINE_ASSERT_EQ +# define ASSERT_EQ(val1, val2) GTEST_ASSERT_EQ(val1, val2) +#endif + +#if !GTEST_DONT_DEFINE_ASSERT_NE +# define ASSERT_NE(val1, val2) GTEST_ASSERT_NE(val1, val2) +#endif + +#if !GTEST_DONT_DEFINE_ASSERT_LE +# define ASSERT_LE(val1, val2) GTEST_ASSERT_LE(val1, val2) +#endif + +#if !GTEST_DONT_DEFINE_ASSERT_LT +# define ASSERT_LT(val1, val2) GTEST_ASSERT_LT(val1, val2) +#endif + +#if !GTEST_DONT_DEFINE_ASSERT_GE +# define ASSERT_GE(val1, val2) GTEST_ASSERT_GE(val1, val2) +#endif + +#if !GTEST_DONT_DEFINE_ASSERT_GT +# define ASSERT_GT(val1, val2) GTEST_ASSERT_GT(val1, val2) +#endif + +// C String Comparisons. All tests treat NULL and any non-NULL string +// as different. Two NULLs are equal. +// +// * {ASSERT|EXPECT}_STREQ(s1, s2): Tests that s1 == s2 +// * {ASSERT|EXPECT}_STRNE(s1, s2): Tests that s1 != s2 +// * {ASSERT|EXPECT}_STRCASEEQ(s1, s2): Tests that s1 == s2, ignoring case +// * {ASSERT|EXPECT}_STRCASENE(s1, s2): Tests that s1 != s2, ignoring case +// +// For wide or narrow string objects, you can use the +// {ASSERT|EXPECT}_??() macros. +// +// Don't depend on the order in which the arguments are evaluated, +// which is undefined. +// +// These macros evaluate their arguments exactly once. + +#define EXPECT_STREQ(expected, actual) \ + EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, expected, actual) +#define EXPECT_STRNE(s1, s2) \ + EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2) +#define EXPECT_STRCASEEQ(expected, actual) \ + EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, expected, actual) +#define EXPECT_STRCASENE(s1, s2)\ + EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2) + +#define ASSERT_STREQ(expected, actual) \ + ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, expected, actual) +#define ASSERT_STRNE(s1, s2) \ + ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2) +#define ASSERT_STRCASEEQ(expected, actual) \ + ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, expected, actual) +#define ASSERT_STRCASENE(s1, s2)\ + ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2) + +// Macros for comparing floating-point numbers. +// +// * {ASSERT|EXPECT}_FLOAT_EQ(expected, actual): +// Tests that two float values are almost equal. +// * {ASSERT|EXPECT}_DOUBLE_EQ(expected, actual): +// Tests that two double values are almost equal. +// * {ASSERT|EXPECT}_NEAR(v1, v2, abs_error): +// Tests that v1 and v2 are within the given distance to each other. +// +// Google Test uses ULP-based comparison to automatically pick a default +// error bound that is appropriate for the operands. See the +// FloatingPoint template class in gtest-internal.h if you are +// interested in the implementation details. + +#define EXPECT_FLOAT_EQ(expected, actual)\ + EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ, \ + expected, actual) + +#define EXPECT_DOUBLE_EQ(expected, actual)\ + EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ, \ + expected, actual) + +#define ASSERT_FLOAT_EQ(expected, actual)\ + ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ, \ + expected, actual) + +#define ASSERT_DOUBLE_EQ(expected, actual)\ + ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ, \ + expected, actual) + +#define EXPECT_NEAR(val1, val2, abs_error)\ + EXPECT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \ + val1, val2, abs_error) + +#define ASSERT_NEAR(val1, val2, abs_error)\ + ASSERT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \ + val1, val2, abs_error) + +// These predicate format functions work on floating-point values, and +// can be used in {ASSERT|EXPECT}_PRED_FORMAT2*(), e.g. +// +// EXPECT_PRED_FORMAT2(testing::DoubleLE, Foo(), 5.0); + +// Asserts that val1 is less than, or almost equal to, val2. Fails +// otherwise. In particular, it fails if either val1 or val2 is NaN. +GTEST_API_ AssertionResult FloatLE(const char* expr1, const char* expr2, + float val1, float val2); +GTEST_API_ AssertionResult DoubleLE(const char* expr1, const char* expr2, + double val1, double val2); + + +#if GTEST_OS_WINDOWS + +// Macros that test for HRESULT failure and success, these are only useful +// on Windows, and rely on Windows SDK macros and APIs to compile. +// +// * {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED}(expr) +// +// When expr unexpectedly fails or succeeds, Google Test prints the +// expected result and the actual result with both a human-readable +// string representation of the error, if available, as well as the +// hex result code. +# define EXPECT_HRESULT_SUCCEEDED(expr) \ + EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr)) + +# define ASSERT_HRESULT_SUCCEEDED(expr) \ + ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr)) + +# define EXPECT_HRESULT_FAILED(expr) \ + EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr)) + +# define ASSERT_HRESULT_FAILED(expr) \ + ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr)) + +#endif // GTEST_OS_WINDOWS + +// Macros that execute statement and check that it doesn't generate new fatal +// failures in the current thread. +// +// * {ASSERT|EXPECT}_NO_FATAL_FAILURE(statement); +// +// Examples: +// +// EXPECT_NO_FATAL_FAILURE(Process()); +// ASSERT_NO_FATAL_FAILURE(Process()) << "Process() failed"; +// +#define ASSERT_NO_FATAL_FAILURE(statement) \ + GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_FATAL_FAILURE_) +#define EXPECT_NO_FATAL_FAILURE(statement) \ + GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_NONFATAL_FAILURE_) + +// Causes a trace (including the source file path, the current line +// number, and the given message) to be included in every test failure +// message generated by code in the current scope. The effect is +// undone when the control leaves the current scope. +// +// The message argument can be anything streamable to std::ostream. +// +// In the implementation, we include the current line number as part +// of the dummy variable name, thus allowing multiple SCOPED_TRACE()s +// to appear in the same block - as long as they are on different +// lines. +#define SCOPED_TRACE(message) \ + ::testing::internal::ScopedTrace GTEST_CONCAT_TOKEN_(gtest_trace_, __LINE__)(\ + __FILE__, __LINE__, ::testing::Message() << (message)) + +// Compile-time assertion for type equality. +// StaticAssertTypeEq() compiles iff type1 and type2 are +// the same type. The value it returns is not interesting. +// +// Instead of making StaticAssertTypeEq a class template, we make it a +// function template that invokes a helper class template. This +// prevents a user from misusing StaticAssertTypeEq by +// defining objects of that type. +// +// CAVEAT: +// +// When used inside a method of a class template, +// StaticAssertTypeEq() is effective ONLY IF the method is +// instantiated. For example, given: +// +// template class Foo { +// public: +// void Bar() { testing::StaticAssertTypeEq(); } +// }; +// +// the code: +// +// void Test1() { Foo foo; } +// +// will NOT generate a compiler error, as Foo::Bar() is never +// actually instantiated. Instead, you need: +// +// void Test2() { Foo foo; foo.Bar(); } +// +// to cause a compiler error. +template +bool StaticAssertTypeEq() { + (void)internal::StaticAssertTypeEqHelper(); + return true; +} + +// Defines a test. +// +// The first parameter is the name of the test case, and the second +// parameter is the name of the test within the test case. +// +// The convention is to end the test case name with "Test". For +// example, a test case for the Foo class can be named FooTest. +// +// The user should put his test code between braces after using this +// macro. Example: +// +// TEST(FooTest, InitializesCorrectly) { +// Foo foo; +// EXPECT_TRUE(foo.StatusIsOK()); +// } + +// Note that we call GetTestTypeId() instead of GetTypeId< +// ::testing::Test>() here to get the type ID of testing::Test. This +// is to work around a suspected linker bug when using Google Test as +// a framework on Mac OS X. The bug causes GetTypeId< +// ::testing::Test>() to return different values depending on whether +// the call is from the Google Test framework itself or from user test +// code. GetTestTypeId() is guaranteed to always return the same +// value, as it always calls GetTypeId<>() from the Google Test +// framework. +#define GTEST_TEST(test_case_name, test_name)\ + GTEST_TEST_(test_case_name, test_name, \ + ::testing::Test, ::testing::internal::GetTestTypeId()) + +// Define this macro to 1 to omit the definition of TEST(), which +// is a generic name and clashes with some other libraries. +#if !GTEST_DONT_DEFINE_TEST +# define TEST(test_case_name, test_name) GTEST_TEST(test_case_name, test_name) +#endif + +// Defines a test that uses a test fixture. +// +// The first parameter is the name of the test fixture class, which +// also doubles as the test case name. The second parameter is the +// name of the test within the test case. +// +// A test fixture class must be declared earlier. The user should put +// his test code between braces after using this macro. Example: +// +// class FooTest : public testing::Test { +// protected: +// virtual void SetUp() { b_.AddElement(3); } +// +// Foo a_; +// Foo b_; +// }; +// +// TEST_F(FooTest, InitializesCorrectly) { +// EXPECT_TRUE(a_.StatusIsOK()); +// } +// +// TEST_F(FooTest, ReturnsElementCountCorrectly) { +// EXPECT_EQ(0, a_.size()); +// EXPECT_EQ(1, b_.size()); +// } + +#define TEST_F(test_fixture, test_name)\ + GTEST_TEST_(test_fixture, test_name, test_fixture, \ + ::testing::internal::GetTypeId()) + +// Use this macro in main() to run all tests. It returns 0 if all +// tests are successful, or 1 otherwise. +// +// RUN_ALL_TESTS() should be invoked after the command line has been +// parsed by InitGoogleTest(). + +#define RUN_ALL_TESTS()\ + (::testing::UnitTest::GetInstance()->Run()) + +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_GTEST_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest_pred_impl.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest_pred_impl.h new file mode 100644 index 0000000000..53be9231d4 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest_pred_impl.h @@ -0,0 +1,358 @@ +// Copyright 2006, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +// This file is AUTOMATICALLY GENERATED on 09/24/2010 by command +// 'gen_gtest_pred_impl.py 5'. DO NOT EDIT BY HAND! +// +// Implements a family of generic predicate assertion macros. + +#ifndef GTEST_INCLUDE_GTEST_GTEST_PRED_IMPL_H_ +#define GTEST_INCLUDE_GTEST_GTEST_PRED_IMPL_H_ + +// Makes sure this header is not included before gtest.h. +#ifndef GTEST_INCLUDE_GTEST_GTEST_H_ +# error Do not include gtest_pred_impl.h directly. Include gtest.h instead. +#endif // GTEST_INCLUDE_GTEST_GTEST_H_ + +// This header implements a family of generic predicate assertion +// macros: +// +// ASSERT_PRED_FORMAT1(pred_format, v1) +// ASSERT_PRED_FORMAT2(pred_format, v1, v2) +// ... +// +// where pred_format is a function or functor that takes n (in the +// case of ASSERT_PRED_FORMATn) values and their source expression +// text, and returns a testing::AssertionResult. See the definition +// of ASSERT_EQ in gtest.h for an example. +// +// If you don't care about formatting, you can use the more +// restrictive version: +// +// ASSERT_PRED1(pred, v1) +// ASSERT_PRED2(pred, v1, v2) +// ... +// +// where pred is an n-ary function or functor that returns bool, +// and the values v1, v2, ..., must support the << operator for +// streaming to std::ostream. +// +// We also define the EXPECT_* variations. +// +// For now we only support predicates whose arity is at most 5. +// Please email googletestframework@googlegroups.com if you need +// support for higher arities. + +// GTEST_ASSERT_ is the basic statement to which all of the assertions +// in this file reduce. Don't use this in your code. + +#define GTEST_ASSERT_(expression, on_failure) \ + GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ + if (const ::testing::AssertionResult gtest_ar = (expression)) \ + ; \ + else \ + on_failure(gtest_ar.failure_message()) + + +// Helper function for implementing {EXPECT|ASSERT}_PRED1. Don't use +// this in your code. +template +AssertionResult AssertPred1Helper(const char* pred_text, + const char* e1, + Pred pred, + const T1& v1) { + if (pred(v1)) return AssertionSuccess(); + + return AssertionFailure() << pred_text << "(" + << e1 << ") evaluates to false, where" + << "\n" << e1 << " evaluates to " << v1; +} + +// Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT1. +// Don't use this in your code. +#define GTEST_PRED_FORMAT1_(pred_format, v1, on_failure)\ + GTEST_ASSERT_(pred_format(#v1, v1),\ + on_failure) + +// Internal macro for implementing {EXPECT|ASSERT}_PRED1. Don't use +// this in your code. +#define GTEST_PRED1_(pred, v1, on_failure)\ + GTEST_ASSERT_(::testing::AssertPred1Helper(#pred, \ + #v1, \ + pred, \ + v1), on_failure) + +// Unary predicate assertion macros. +#define EXPECT_PRED_FORMAT1(pred_format, v1) \ + GTEST_PRED_FORMAT1_(pred_format, v1, GTEST_NONFATAL_FAILURE_) +#define EXPECT_PRED1(pred, v1) \ + GTEST_PRED1_(pred, v1, GTEST_NONFATAL_FAILURE_) +#define ASSERT_PRED_FORMAT1(pred_format, v1) \ + GTEST_PRED_FORMAT1_(pred_format, v1, GTEST_FATAL_FAILURE_) +#define ASSERT_PRED1(pred, v1) \ + GTEST_PRED1_(pred, v1, GTEST_FATAL_FAILURE_) + + + +// Helper function for implementing {EXPECT|ASSERT}_PRED2. Don't use +// this in your code. +template +AssertionResult AssertPred2Helper(const char* pred_text, + const char* e1, + const char* e2, + Pred pred, + const T1& v1, + const T2& v2) { + if (pred(v1, v2)) return AssertionSuccess(); + + return AssertionFailure() << pred_text << "(" + << e1 << ", " + << e2 << ") evaluates to false, where" + << "\n" << e1 << " evaluates to " << v1 + << "\n" << e2 << " evaluates to " << v2; +} + +// Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT2. +// Don't use this in your code. +#define GTEST_PRED_FORMAT2_(pred_format, v1, v2, on_failure)\ + GTEST_ASSERT_(pred_format(#v1, #v2, v1, v2),\ + on_failure) + +// Internal macro for implementing {EXPECT|ASSERT}_PRED2. Don't use +// this in your code. +#define GTEST_PRED2_(pred, v1, v2, on_failure)\ + GTEST_ASSERT_(::testing::AssertPred2Helper(#pred, \ + #v1, \ + #v2, \ + pred, \ + v1, \ + v2), on_failure) + +// Binary predicate assertion macros. +#define EXPECT_PRED_FORMAT2(pred_format, v1, v2) \ + GTEST_PRED_FORMAT2_(pred_format, v1, v2, GTEST_NONFATAL_FAILURE_) +#define EXPECT_PRED2(pred, v1, v2) \ + GTEST_PRED2_(pred, v1, v2, GTEST_NONFATAL_FAILURE_) +#define ASSERT_PRED_FORMAT2(pred_format, v1, v2) \ + GTEST_PRED_FORMAT2_(pred_format, v1, v2, GTEST_FATAL_FAILURE_) +#define ASSERT_PRED2(pred, v1, v2) \ + GTEST_PRED2_(pred, v1, v2, GTEST_FATAL_FAILURE_) + + + +// Helper function for implementing {EXPECT|ASSERT}_PRED3. Don't use +// this in your code. +template +AssertionResult AssertPred3Helper(const char* pred_text, + const char* e1, + const char* e2, + const char* e3, + Pred pred, + const T1& v1, + const T2& v2, + const T3& v3) { + if (pred(v1, v2, v3)) return AssertionSuccess(); + + return AssertionFailure() << pred_text << "(" + << e1 << ", " + << e2 << ", " + << e3 << ") evaluates to false, where" + << "\n" << e1 << " evaluates to " << v1 + << "\n" << e2 << " evaluates to " << v2 + << "\n" << e3 << " evaluates to " << v3; +} + +// Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT3. +// Don't use this in your code. +#define GTEST_PRED_FORMAT3_(pred_format, v1, v2, v3, on_failure)\ + GTEST_ASSERT_(pred_format(#v1, #v2, #v3, v1, v2, v3),\ + on_failure) + +// Internal macro for implementing {EXPECT|ASSERT}_PRED3. Don't use +// this in your code. +#define GTEST_PRED3_(pred, v1, v2, v3, on_failure)\ + GTEST_ASSERT_(::testing::AssertPred3Helper(#pred, \ + #v1, \ + #v2, \ + #v3, \ + pred, \ + v1, \ + v2, \ + v3), on_failure) + +// Ternary predicate assertion macros. +#define EXPECT_PRED_FORMAT3(pred_format, v1, v2, v3) \ + GTEST_PRED_FORMAT3_(pred_format, v1, v2, v3, GTEST_NONFATAL_FAILURE_) +#define EXPECT_PRED3(pred, v1, v2, v3) \ + GTEST_PRED3_(pred, v1, v2, v3, GTEST_NONFATAL_FAILURE_) +#define ASSERT_PRED_FORMAT3(pred_format, v1, v2, v3) \ + GTEST_PRED_FORMAT3_(pred_format, v1, v2, v3, GTEST_FATAL_FAILURE_) +#define ASSERT_PRED3(pred, v1, v2, v3) \ + GTEST_PRED3_(pred, v1, v2, v3, GTEST_FATAL_FAILURE_) + + + +// Helper function for implementing {EXPECT|ASSERT}_PRED4. Don't use +// this in your code. +template +AssertionResult AssertPred4Helper(const char* pred_text, + const char* e1, + const char* e2, + const char* e3, + const char* e4, + Pred pred, + const T1& v1, + const T2& v2, + const T3& v3, + const T4& v4) { + if (pred(v1, v2, v3, v4)) return AssertionSuccess(); + + return AssertionFailure() << pred_text << "(" + << e1 << ", " + << e2 << ", " + << e3 << ", " + << e4 << ") evaluates to false, where" + << "\n" << e1 << " evaluates to " << v1 + << "\n" << e2 << " evaluates to " << v2 + << "\n" << e3 << " evaluates to " << v3 + << "\n" << e4 << " evaluates to " << v4; +} + +// Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT4. +// Don't use this in your code. +#define GTEST_PRED_FORMAT4_(pred_format, v1, v2, v3, v4, on_failure)\ + GTEST_ASSERT_(pred_format(#v1, #v2, #v3, #v4, v1, v2, v3, v4),\ + on_failure) + +// Internal macro for implementing {EXPECT|ASSERT}_PRED4. Don't use +// this in your code. +#define GTEST_PRED4_(pred, v1, v2, v3, v4, on_failure)\ + GTEST_ASSERT_(::testing::AssertPred4Helper(#pred, \ + #v1, \ + #v2, \ + #v3, \ + #v4, \ + pred, \ + v1, \ + v2, \ + v3, \ + v4), on_failure) + +// 4-ary predicate assertion macros. +#define EXPECT_PRED_FORMAT4(pred_format, v1, v2, v3, v4) \ + GTEST_PRED_FORMAT4_(pred_format, v1, v2, v3, v4, GTEST_NONFATAL_FAILURE_) +#define EXPECT_PRED4(pred, v1, v2, v3, v4) \ + GTEST_PRED4_(pred, v1, v2, v3, v4, GTEST_NONFATAL_FAILURE_) +#define ASSERT_PRED_FORMAT4(pred_format, v1, v2, v3, v4) \ + GTEST_PRED_FORMAT4_(pred_format, v1, v2, v3, v4, GTEST_FATAL_FAILURE_) +#define ASSERT_PRED4(pred, v1, v2, v3, v4) \ + GTEST_PRED4_(pred, v1, v2, v3, v4, GTEST_FATAL_FAILURE_) + + + +// Helper function for implementing {EXPECT|ASSERT}_PRED5. Don't use +// this in your code. +template +AssertionResult AssertPred5Helper(const char* pred_text, + const char* e1, + const char* e2, + const char* e3, + const char* e4, + const char* e5, + Pred pred, + const T1& v1, + const T2& v2, + const T3& v3, + const T4& v4, + const T5& v5) { + if (pred(v1, v2, v3, v4, v5)) return AssertionSuccess(); + + return AssertionFailure() << pred_text << "(" + << e1 << ", " + << e2 << ", " + << e3 << ", " + << e4 << ", " + << e5 << ") evaluates to false, where" + << "\n" << e1 << " evaluates to " << v1 + << "\n" << e2 << " evaluates to " << v2 + << "\n" << e3 << " evaluates to " << v3 + << "\n" << e4 << " evaluates to " << v4 + << "\n" << e5 << " evaluates to " << v5; +} + +// Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT5. +// Don't use this in your code. +#define GTEST_PRED_FORMAT5_(pred_format, v1, v2, v3, v4, v5, on_failure)\ + GTEST_ASSERT_(pred_format(#v1, #v2, #v3, #v4, #v5, v1, v2, v3, v4, v5),\ + on_failure) + +// Internal macro for implementing {EXPECT|ASSERT}_PRED5. Don't use +// this in your code. +#define GTEST_PRED5_(pred, v1, v2, v3, v4, v5, on_failure)\ + GTEST_ASSERT_(::testing::AssertPred5Helper(#pred, \ + #v1, \ + #v2, \ + #v3, \ + #v4, \ + #v5, \ + pred, \ + v1, \ + v2, \ + v3, \ + v4, \ + v5), on_failure) + +// 5-ary predicate assertion macros. +#define EXPECT_PRED_FORMAT5(pred_format, v1, v2, v3, v4, v5) \ + GTEST_PRED_FORMAT5_(pred_format, v1, v2, v3, v4, v5, GTEST_NONFATAL_FAILURE_) +#define EXPECT_PRED5(pred, v1, v2, v3, v4, v5) \ + GTEST_PRED5_(pred, v1, v2, v3, v4, v5, GTEST_NONFATAL_FAILURE_) +#define ASSERT_PRED_FORMAT5(pred_format, v1, v2, v3, v4, v5) \ + GTEST_PRED_FORMAT5_(pred_format, v1, v2, v3, v4, v5, GTEST_FATAL_FAILURE_) +#define ASSERT_PRED5(pred, v1, v2, v3, v4, v5) \ + GTEST_PRED5_(pred, v1, v2, v3, v4, v5, GTEST_FATAL_FAILURE_) + + + +#endif // GTEST_INCLUDE_GTEST_GTEST_PRED_IMPL_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest_prod.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest_prod.h new file mode 100644 index 0000000000..0babe93c30 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/gtest_prod.h @@ -0,0 +1,58 @@ +// Copyright 2006, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) +// +// Google C++ Testing Framework definitions useful in production code. + +#ifndef GTEST_INCLUDE_GTEST_GTEST_PROD_H_ +#define GTEST_INCLUDE_GTEST_GTEST_PROD_H_ + +// When you need to test the private or protected members of a class, +// use the FRIEND_TEST macro to declare your tests as friends of the +// class. For example: +// +// class MyClass { +// private: +// void MyMethod(); +// FRIEND_TEST(MyClassTest, MyMethod); +// }; +// +// class MyClassTest : public testing::Test { +// // ... +// }; +// +// TEST_F(MyClassTest, MyMethod) { +// // Can call MyClass::MyMethod() here. +// } + +#define FRIEND_TEST(test_case_name, test_name)\ +friend class test_case_name##_##test_name##_Test + +#endif // GTEST_INCLUDE_GTEST_GTEST_PROD_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-death-test-internal.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-death-test-internal.h new file mode 100644 index 0000000000..ba07541f00 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-death-test-internal.h @@ -0,0 +1,308 @@ +// Copyright 2005, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Authors: wan@google.com (Zhanyong Wan), eefacm@gmail.com (Sean Mcafee) +// +// The Google C++ Testing Framework (Google Test) +// +// This header file defines internal utilities needed for implementing +// death tests. They are subject to change without notice. + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_DEATH_TEST_INTERNAL_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_DEATH_TEST_INTERNAL_H_ + +#include "gtest/internal/gtest-internal.h" + +#include + +namespace testing { +namespace internal { + +GTEST_DECLARE_string_(internal_run_death_test); + +// Names of the flags (needed for parsing Google Test flags). +const char kDeathTestStyleFlag[] = "death_test_style"; +const char kDeathTestUseFork[] = "death_test_use_fork"; +const char kInternalRunDeathTestFlag[] = "internal_run_death_test"; + +#if GTEST_HAS_DEATH_TEST + +// DeathTest is a class that hides much of the complexity of the +// GTEST_DEATH_TEST_ macro. It is abstract; its static Create method +// returns a concrete class that depends on the prevailing death test +// style, as defined by the --gtest_death_test_style and/or +// --gtest_internal_run_death_test flags. + +// In describing the results of death tests, these terms are used with +// the corresponding definitions: +// +// exit status: The integer exit information in the format specified +// by wait(2) +// exit code: The integer code passed to exit(3), _exit(2), or +// returned from main() +class GTEST_API_ DeathTest { + public: + // Create returns false if there was an error determining the + // appropriate action to take for the current death test; for example, + // if the gtest_death_test_style flag is set to an invalid value. + // The LastMessage method will return a more detailed message in that + // case. Otherwise, the DeathTest pointer pointed to by the "test" + // argument is set. If the death test should be skipped, the pointer + // is set to NULL; otherwise, it is set to the address of a new concrete + // DeathTest object that controls the execution of the current test. + static bool Create(const char* statement, const RE* regex, + const char* file, int line, DeathTest** test); + DeathTest(); + virtual ~DeathTest() { } + + // A helper class that aborts a death test when it's deleted. + class ReturnSentinel { + public: + explicit ReturnSentinel(DeathTest* test) : test_(test) { } + ~ReturnSentinel() { test_->Abort(TEST_ENCOUNTERED_RETURN_STATEMENT); } + private: + DeathTest* const test_; + GTEST_DISALLOW_COPY_AND_ASSIGN_(ReturnSentinel); + } GTEST_ATTRIBUTE_UNUSED_; + + // An enumeration of possible roles that may be taken when a death + // test is encountered. EXECUTE means that the death test logic should + // be executed immediately. OVERSEE means that the program should prepare + // the appropriate environment for a child process to execute the death + // test, then wait for it to complete. + enum TestRole { OVERSEE_TEST, EXECUTE_TEST }; + + // An enumeration of the three reasons that a test might be aborted. + enum AbortReason { + TEST_ENCOUNTERED_RETURN_STATEMENT, + TEST_THREW_EXCEPTION, + TEST_DID_NOT_DIE + }; + + // Assumes one of the above roles. + virtual TestRole AssumeRole() = 0; + + // Waits for the death test to finish and returns its status. + virtual int Wait() = 0; + + // Returns true if the death test passed; that is, the test process + // exited during the test, its exit status matches a user-supplied + // predicate, and its stderr output matches a user-supplied regular + // expression. + // The user-supplied predicate may be a macro expression rather + // than a function pointer or functor, or else Wait and Passed could + // be combined. + virtual bool Passed(bool exit_status_ok) = 0; + + // Signals that the death test did not die as expected. + virtual void Abort(AbortReason reason) = 0; + + // Returns a human-readable outcome message regarding the outcome of + // the last death test. + static const char* LastMessage(); + + static void set_last_death_test_message(const String& message); + + private: + // A string containing a description of the outcome of the last death test. + static String last_death_test_message_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(DeathTest); +}; + +// Factory interface for death tests. May be mocked out for testing. +class DeathTestFactory { + public: + virtual ~DeathTestFactory() { } + virtual bool Create(const char* statement, const RE* regex, + const char* file, int line, DeathTest** test) = 0; +}; + +// A concrete DeathTestFactory implementation for normal use. +class DefaultDeathTestFactory : public DeathTestFactory { + public: + virtual bool Create(const char* statement, const RE* regex, + const char* file, int line, DeathTest** test); +}; + +// Returns true if exit_status describes a process that was terminated +// by a signal, or exited normally with a nonzero exit code. +GTEST_API_ bool ExitedUnsuccessfully(int exit_status); + +// Traps C++ exceptions escaping statement and reports them as test +// failures. Note that trapping SEH exceptions is not implemented here. +# if GTEST_HAS_EXCEPTIONS +# define GTEST_EXECUTE_DEATH_TEST_STATEMENT_(statement, death_test) \ + try { \ + GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ + } catch (const ::std::exception& gtest_exception) { \ + fprintf(\ + stderr, \ + "\n%s: Caught std::exception-derived exception escaping the " \ + "death test statement. Exception message: %s\n", \ + ::testing::internal::FormatFileLocation(__FILE__, __LINE__).c_str(), \ + gtest_exception.what()); \ + fflush(stderr); \ + death_test->Abort(::testing::internal::DeathTest::TEST_THREW_EXCEPTION); \ + } catch (...) { \ + death_test->Abort(::testing::internal::DeathTest::TEST_THREW_EXCEPTION); \ + } + +# else +# define GTEST_EXECUTE_DEATH_TEST_STATEMENT_(statement, death_test) \ + GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement) + +# endif + +// This macro is for implementing ASSERT_DEATH*, EXPECT_DEATH*, +// ASSERT_EXIT*, and EXPECT_EXIT*. +# define GTEST_DEATH_TEST_(statement, predicate, regex, fail) \ + GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ + if (::testing::internal::AlwaysTrue()) { \ + const ::testing::internal::RE& gtest_regex = (regex); \ + ::testing::internal::DeathTest* gtest_dt; \ + if (!::testing::internal::DeathTest::Create(#statement, >est_regex, \ + __FILE__, __LINE__, >est_dt)) { \ + goto GTEST_CONCAT_TOKEN_(gtest_label_, __LINE__); \ + } \ + if (gtest_dt != NULL) { \ + ::testing::internal::scoped_ptr< ::testing::internal::DeathTest> \ + gtest_dt_ptr(gtest_dt); \ + switch (gtest_dt->AssumeRole()) { \ + case ::testing::internal::DeathTest::OVERSEE_TEST: \ + if (!gtest_dt->Passed(predicate(gtest_dt->Wait()))) { \ + goto GTEST_CONCAT_TOKEN_(gtest_label_, __LINE__); \ + } \ + break; \ + case ::testing::internal::DeathTest::EXECUTE_TEST: { \ + ::testing::internal::DeathTest::ReturnSentinel \ + gtest_sentinel(gtest_dt); \ + GTEST_EXECUTE_DEATH_TEST_STATEMENT_(statement, gtest_dt); \ + gtest_dt->Abort(::testing::internal::DeathTest::TEST_DID_NOT_DIE); \ + break; \ + } \ + default: \ + break; \ + } \ + } \ + } else \ + GTEST_CONCAT_TOKEN_(gtest_label_, __LINE__): \ + fail(::testing::internal::DeathTest::LastMessage()) +// The symbol "fail" here expands to something into which a message +// can be streamed. + +// A class representing the parsed contents of the +// --gtest_internal_run_death_test flag, as it existed when +// RUN_ALL_TESTS was called. +class InternalRunDeathTestFlag { + public: + InternalRunDeathTestFlag(const String& a_file, + int a_line, + int an_index, + int a_write_fd) + : file_(a_file), line_(a_line), index_(an_index), + write_fd_(a_write_fd) {} + + ~InternalRunDeathTestFlag() { + if (write_fd_ >= 0) + posix::Close(write_fd_); + } + + String file() const { return file_; } + int line() const { return line_; } + int index() const { return index_; } + int write_fd() const { return write_fd_; } + + private: + String file_; + int line_; + int index_; + int write_fd_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(InternalRunDeathTestFlag); +}; + +// Returns a newly created InternalRunDeathTestFlag object with fields +// initialized from the GTEST_FLAG(internal_run_death_test) flag if +// the flag is specified; otherwise returns NULL. +InternalRunDeathTestFlag* ParseInternalRunDeathTestFlag(); + +#else // GTEST_HAS_DEATH_TEST + +// This macro is used for implementing macros such as +// EXPECT_DEATH_IF_SUPPORTED and ASSERT_DEATH_IF_SUPPORTED on systems where +// death tests are not supported. Those macros must compile on such systems +// iff EXPECT_DEATH and ASSERT_DEATH compile with the same parameters on +// systems that support death tests. This allows one to write such a macro +// on a system that does not support death tests and be sure that it will +// compile on a death-test supporting system. +// +// Parameters: +// statement - A statement that a macro such as EXPECT_DEATH would test +// for program termination. This macro has to make sure this +// statement is compiled but not executed, to ensure that +// EXPECT_DEATH_IF_SUPPORTED compiles with a certain +// parameter iff EXPECT_DEATH compiles with it. +// regex - A regex that a macro such as EXPECT_DEATH would use to test +// the output of statement. This parameter has to be +// compiled but not evaluated by this macro, to ensure that +// this macro only accepts expressions that a macro such as +// EXPECT_DEATH would accept. +// terminator - Must be an empty statement for EXPECT_DEATH_IF_SUPPORTED +// and a return statement for ASSERT_DEATH_IF_SUPPORTED. +// This ensures that ASSERT_DEATH_IF_SUPPORTED will not +// compile inside functions where ASSERT_DEATH doesn't +// compile. +// +// The branch that has an always false condition is used to ensure that +// statement and regex are compiled (and thus syntactically correct) but +// never executed. The unreachable code macro protects the terminator +// statement from generating an 'unreachable code' warning in case +// statement unconditionally returns or throws. The Message constructor at +// the end allows the syntax of streaming additional messages into the +// macro, for compilational compatibility with EXPECT_DEATH/ASSERT_DEATH. +# define GTEST_UNSUPPORTED_DEATH_TEST_(statement, regex, terminator) \ + GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ + if (::testing::internal::AlwaysTrue()) { \ + GTEST_LOG_(WARNING) \ + << "Death tests are not supported on this platform.\n" \ + << "Statement '" #statement "' cannot be verified."; \ + } else if (::testing::internal::AlwaysFalse()) { \ + ::testing::internal::RE::PartialMatch(".*", (regex)); \ + GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ + terminator; \ + } else \ + ::testing::Message() + +#endif // GTEST_HAS_DEATH_TEST + +} // namespace internal +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_DEATH_TEST_INTERNAL_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-filepath.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-filepath.h new file mode 100644 index 0000000000..6c08fe5aad --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-filepath.h @@ -0,0 +1,210 @@ +// Copyright 2008, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: keith.ray@gmail.com (Keith Ray) +// +// Google Test filepath utilities +// +// This header file declares classes and functions used internally by +// Google Test. They are subject to change without notice. +// +// This file is #included in . +// Do not include this header file separately! + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_ + +#include "gtest/internal/gtest-string.h" + +namespace testing { +namespace internal { + +// FilePath - a class for file and directory pathname manipulation which +// handles platform-specific conventions (like the pathname separator). +// Used for helper functions for naming files in a directory for xml output. +// Except for Set methods, all methods are const or static, which provides an +// "immutable value object" -- useful for peace of mind. +// A FilePath with a value ending in a path separator ("like/this/") represents +// a directory, otherwise it is assumed to represent a file. In either case, +// it may or may not represent an actual file or directory in the file system. +// Names are NOT checked for syntax correctness -- no checking for illegal +// characters, malformed paths, etc. + +class GTEST_API_ FilePath { + public: + FilePath() : pathname_("") { } + FilePath(const FilePath& rhs) : pathname_(rhs.pathname_) { } + + explicit FilePath(const char* pathname) : pathname_(pathname) { + Normalize(); + } + + explicit FilePath(const String& pathname) : pathname_(pathname) { + Normalize(); + } + + FilePath& operator=(const FilePath& rhs) { + Set(rhs); + return *this; + } + + void Set(const FilePath& rhs) { + pathname_ = rhs.pathname_; + } + + String ToString() const { return pathname_; } + const char* c_str() const { return pathname_.c_str(); } + + // Returns the current working directory, or "" if unsuccessful. + static FilePath GetCurrentDir(); + + // Given directory = "dir", base_name = "test", number = 0, + // extension = "xml", returns "dir/test.xml". If number is greater + // than zero (e.g., 12), returns "dir/test_12.xml". + // On Windows platform, uses \ as the separator rather than /. + static FilePath MakeFileName(const FilePath& directory, + const FilePath& base_name, + int number, + const char* extension); + + // Given directory = "dir", relative_path = "test.xml", + // returns "dir/test.xml". + // On Windows, uses \ as the separator rather than /. + static FilePath ConcatPaths(const FilePath& directory, + const FilePath& relative_path); + + // Returns a pathname for a file that does not currently exist. The pathname + // will be directory/base_name.extension or + // directory/base_name_.extension if directory/base_name.extension + // already exists. The number will be incremented until a pathname is found + // that does not already exist. + // Examples: 'dir/foo_test.xml' or 'dir/foo_test_1.xml'. + // There could be a race condition if two or more processes are calling this + // function at the same time -- they could both pick the same filename. + static FilePath GenerateUniqueFileName(const FilePath& directory, + const FilePath& base_name, + const char* extension); + + // Returns true iff the path is NULL or "". + bool IsEmpty() const { return c_str() == NULL || *c_str() == '\0'; } + + // If input name has a trailing separator character, removes it and returns + // the name, otherwise return the name string unmodified. + // On Windows platform, uses \ as the separator, other platforms use /. + FilePath RemoveTrailingPathSeparator() const; + + // Returns a copy of the FilePath with the directory part removed. + // Example: FilePath("path/to/file").RemoveDirectoryName() returns + // FilePath("file"). If there is no directory part ("just_a_file"), it returns + // the FilePath unmodified. If there is no file part ("just_a_dir/") it + // returns an empty FilePath (""). + // On Windows platform, '\' is the path separator, otherwise it is '/'. + FilePath RemoveDirectoryName() const; + + // RemoveFileName returns the directory path with the filename removed. + // Example: FilePath("path/to/file").RemoveFileName() returns "path/to/". + // If the FilePath is "a_file" or "/a_file", RemoveFileName returns + // FilePath("./") or, on Windows, FilePath(".\\"). If the filepath does + // not have a file, like "just/a/dir/", it returns the FilePath unmodified. + // On Windows platform, '\' is the path separator, otherwise it is '/'. + FilePath RemoveFileName() const; + + // Returns a copy of the FilePath with the case-insensitive extension removed. + // Example: FilePath("dir/file.exe").RemoveExtension("EXE") returns + // FilePath("dir/file"). If a case-insensitive extension is not + // found, returns a copy of the original FilePath. + FilePath RemoveExtension(const char* extension) const; + + // Creates directories so that path exists. Returns true if successful or if + // the directories already exist; returns false if unable to create + // directories for any reason. Will also return false if the FilePath does + // not represent a directory (that is, it doesn't end with a path separator). + bool CreateDirectoriesRecursively() const; + + // Create the directory so that path exists. Returns true if successful or + // if the directory already exists; returns false if unable to create the + // directory for any reason, including if the parent directory does not + // exist. Not named "CreateDirectory" because that's a macro on Windows. + bool CreateFolder() const; + + // Returns true if FilePath describes something in the file-system, + // either a file, directory, or whatever, and that something exists. + bool FileOrDirectoryExists() const; + + // Returns true if pathname describes a directory in the file-system + // that exists. + bool DirectoryExists() const; + + // Returns true if FilePath ends with a path separator, which indicates that + // it is intended to represent a directory. Returns false otherwise. + // This does NOT check that a directory (or file) actually exists. + bool IsDirectory() const; + + // Returns true if pathname describes a root directory. (Windows has one + // root directory per disk drive.) + bool IsRootDirectory() const; + + // Returns true if pathname describes an absolute path. + bool IsAbsolutePath() const; + + private: + // Replaces multiple consecutive separators with a single separator. + // For example, "bar///foo" becomes "bar/foo". Does not eliminate other + // redundancies that might be in a pathname involving "." or "..". + // + // A pathname with multiple consecutive separators may occur either through + // user error or as a result of some scripts or APIs that generate a pathname + // with a trailing separator. On other platforms the same API or script + // may NOT generate a pathname with a trailing "/". Then elsewhere that + // pathname may have another "/" and pathname components added to it, + // without checking for the separator already being there. + // The script language and operating system may allow paths like "foo//bar" + // but some of the functions in FilePath will not handle that correctly. In + // particular, RemoveTrailingPathSeparator() only removes one separator, and + // it is called in CreateDirectoriesRecursively() assuming that it will change + // a pathname from directory syntax (trailing separator) to filename syntax. + // + // On Windows this method also replaces the alternate path separator '/' with + // the primary path separator '\\', so that for example "bar\\/\\foo" becomes + // "bar\\foo". + + void Normalize(); + + // Returns a pointer to the last occurence of a valid path separator in + // the FilePath. On Windows, for example, both '/' and '\' are valid path + // separators. Returns NULL if no path separator was found. + const char* FindLastPathSeparator() const; + + String pathname_; +}; // class FilePath + +} // namespace internal +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-internal.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-internal.h new file mode 100644 index 0000000000..f13f831782 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-internal.h @@ -0,0 +1,1226 @@ +// Copyright 2005, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Authors: wan@google.com (Zhanyong Wan), eefacm@gmail.com (Sean Mcafee) +// +// The Google C++ Testing Framework (Google Test) +// +// This header file declares functions and macros used internally by +// Google Test. They are subject to change without notice. + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_ + +#include "gtest/internal/gtest-port.h" + +#if GTEST_OS_LINUX +# include +# include +# include +# include +#endif // GTEST_OS_LINUX + +#include +#include +#include +#include +#include + +#include "gtest/internal/gtest-string.h" +#include "gtest/internal/gtest-filepath.h" +#include "gtest/internal/gtest-type-util.h" + +// Due to C++ preprocessor weirdness, we need double indirection to +// concatenate two tokens when one of them is __LINE__. Writing +// +// foo ## __LINE__ +// +// will result in the token foo__LINE__, instead of foo followed by +// the current line number. For more details, see +// http://www.parashift.com/c++-faq-lite/misc-technical-issues.html#faq-39.6 +#define GTEST_CONCAT_TOKEN_(foo, bar) GTEST_CONCAT_TOKEN_IMPL_(foo, bar) +#define GTEST_CONCAT_TOKEN_IMPL_(foo, bar) foo ## bar + +// Google Test defines the testing::Message class to allow construction of +// test messages via the << operator. The idea is that anything +// streamable to std::ostream can be streamed to a testing::Message. +// This allows a user to use his own types in Google Test assertions by +// overloading the << operator. +// +// util/gtl/stl_logging-inl.h overloads << for STL containers. These +// overloads cannot be defined in the std namespace, as that will be +// undefined behavior. Therefore, they are defined in the global +// namespace instead. +// +// C++'s symbol lookup rule (i.e. Koenig lookup) says that these +// overloads are visible in either the std namespace or the global +// namespace, but not other namespaces, including the testing +// namespace which Google Test's Message class is in. +// +// To allow STL containers (and other types that has a << operator +// defined in the global namespace) to be used in Google Test assertions, +// testing::Message must access the custom << operator from the global +// namespace. Hence this helper function. +// +// Note: Jeffrey Yasskin suggested an alternative fix by "using +// ::operator<<;" in the definition of Message's operator<<. That fix +// doesn't require a helper function, but unfortunately doesn't +// compile with MSVC. +template +inline void GTestStreamToHelper(std::ostream* os, const T& val) { + *os << val; +} + +class ProtocolMessage; +namespace proto2 { class Message; } + +namespace testing { + +// Forward declarations. + +class AssertionResult; // Result of an assertion. +class Message; // Represents a failure message. +class Test; // Represents a test. +class TestInfo; // Information about a test. +class TestPartResult; // Result of a test part. +class UnitTest; // A collection of test cases. + +template +::std::string PrintToString(const T& value); + +namespace internal { + +struct TraceInfo; // Information about a trace point. +class ScopedTrace; // Implements scoped trace. +class TestInfoImpl; // Opaque implementation of TestInfo +class UnitTestImpl; // Opaque implementation of UnitTest + +// How many times InitGoogleTest() has been called. +extern int g_init_gtest_count; + +// The text used in failure messages to indicate the start of the +// stack trace. +GTEST_API_ extern const char kStackTraceMarker[]; + +// A secret type that Google Test users don't know about. It has no +// definition on purpose. Therefore it's impossible to create a +// Secret object, which is what we want. +class Secret; + +// Two overloaded helpers for checking at compile time whether an +// expression is a null pointer literal (i.e. NULL or any 0-valued +// compile-time integral constant). Their return values have +// different sizes, so we can use sizeof() to test which version is +// picked by the compiler. These helpers have no implementations, as +// we only need their signatures. +// +// Given IsNullLiteralHelper(x), the compiler will pick the first +// version if x can be implicitly converted to Secret*, and pick the +// second version otherwise. Since Secret is a secret and incomplete +// type, the only expression a user can write that has type Secret* is +// a null pointer literal. Therefore, we know that x is a null +// pointer literal if and only if the first version is picked by the +// compiler. +char IsNullLiteralHelper(Secret* p); +char (&IsNullLiteralHelper(...))[2]; // NOLINT + +// A compile-time bool constant that is true if and only if x is a +// null pointer literal (i.e. NULL or any 0-valued compile-time +// integral constant). +#ifdef GTEST_ELLIPSIS_NEEDS_POD_ +// We lose support for NULL detection where the compiler doesn't like +// passing non-POD classes through ellipsis (...). +# define GTEST_IS_NULL_LITERAL_(x) false +#else +# define GTEST_IS_NULL_LITERAL_(x) \ + (sizeof(::testing::internal::IsNullLiteralHelper(x)) == 1) +#endif // GTEST_ELLIPSIS_NEEDS_POD_ + +// Appends the user-supplied message to the Google-Test-generated message. +GTEST_API_ String AppendUserMessage(const String& gtest_msg, + const Message& user_msg); + +// A helper class for creating scoped traces in user programs. +class GTEST_API_ ScopedTrace { + public: + // The c'tor pushes the given source file location and message onto + // a trace stack maintained by Google Test. + ScopedTrace(const char* file, int line, const Message& message); + + // The d'tor pops the info pushed by the c'tor. + // + // Note that the d'tor is not virtual in order to be efficient. + // Don't inherit from ScopedTrace! + ~ScopedTrace(); + + private: + GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedTrace); +} GTEST_ATTRIBUTE_UNUSED_; // A ScopedTrace object does its job in its + // c'tor and d'tor. Therefore it doesn't + // need to be used otherwise. + +// Converts a streamable value to a String. A NULL pointer is +// converted to "(null)". When the input value is a ::string, +// ::std::string, ::wstring, or ::std::wstring object, each NUL +// character in it is replaced with "\\0". +// Declared here but defined in gtest.h, so that it has access +// to the definition of the Message class, required by the ARM +// compiler. +template +String StreamableToString(const T& streamable); + +// The Symbian compiler has a bug that prevents it from selecting the +// correct overload of FormatForComparisonFailureMessage (see below) +// unless we pass the first argument by reference. If we do that, +// however, Visual Age C++ 10.1 generates a compiler error. Therefore +// we only apply the work-around for Symbian. +#if defined(__SYMBIAN32__) +# define GTEST_CREF_WORKAROUND_ const& +#else +# define GTEST_CREF_WORKAROUND_ +#endif + +// When this operand is a const char* or char*, if the other operand +// is a ::std::string or ::string, we print this operand as a C string +// rather than a pointer (we do the same for wide strings); otherwise +// we print it as a pointer to be safe. + +// This internal macro is used to avoid duplicated code. +#define GTEST_FORMAT_IMPL_(operand2_type, operand1_printer)\ +inline String FormatForComparisonFailureMessage(\ + operand2_type::value_type* GTEST_CREF_WORKAROUND_ str, \ + const operand2_type& /*operand2*/) {\ + return operand1_printer(str);\ +}\ +inline String FormatForComparisonFailureMessage(\ + const operand2_type::value_type* GTEST_CREF_WORKAROUND_ str, \ + const operand2_type& /*operand2*/) {\ + return operand1_printer(str);\ +} + +GTEST_FORMAT_IMPL_(::std::string, String::ShowCStringQuoted) +#if GTEST_HAS_STD_WSTRING +GTEST_FORMAT_IMPL_(::std::wstring, String::ShowWideCStringQuoted) +#endif // GTEST_HAS_STD_WSTRING + +#if GTEST_HAS_GLOBAL_STRING +GTEST_FORMAT_IMPL_(::string, String::ShowCStringQuoted) +#endif // GTEST_HAS_GLOBAL_STRING +#if GTEST_HAS_GLOBAL_WSTRING +GTEST_FORMAT_IMPL_(::wstring, String::ShowWideCStringQuoted) +#endif // GTEST_HAS_GLOBAL_WSTRING + +#undef GTEST_FORMAT_IMPL_ + +// The next four overloads handle the case where the operand being +// printed is a char/wchar_t pointer and the other operand is not a +// string/wstring object. In such cases, we just print the operand as +// a pointer to be safe. +#define GTEST_FORMAT_CHAR_PTR_IMPL_(CharType) \ + template \ + String FormatForComparisonFailureMessage(CharType* GTEST_CREF_WORKAROUND_ p, \ + const T&) { \ + return PrintToString(static_cast(p)); \ + } + +GTEST_FORMAT_CHAR_PTR_IMPL_(char) +GTEST_FORMAT_CHAR_PTR_IMPL_(const char) +GTEST_FORMAT_CHAR_PTR_IMPL_(wchar_t) +GTEST_FORMAT_CHAR_PTR_IMPL_(const wchar_t) + +#undef GTEST_FORMAT_CHAR_PTR_IMPL_ + +// Constructs and returns the message for an equality assertion +// (e.g. ASSERT_EQ, EXPECT_STREQ, etc) failure. +// +// The first four parameters are the expressions used in the assertion +// and their values, as strings. For example, for ASSERT_EQ(foo, bar) +// where foo is 5 and bar is 6, we have: +// +// expected_expression: "foo" +// actual_expression: "bar" +// expected_value: "5" +// actual_value: "6" +// +// The ignoring_case parameter is true iff the assertion is a +// *_STRCASEEQ*. When it's true, the string " (ignoring case)" will +// be inserted into the message. +GTEST_API_ AssertionResult EqFailure(const char* expected_expression, + const char* actual_expression, + const String& expected_value, + const String& actual_value, + bool ignoring_case); + +// Constructs a failure message for Boolean assertions such as EXPECT_TRUE. +GTEST_API_ String GetBoolAssertionFailureMessage( + const AssertionResult& assertion_result, + const char* expression_text, + const char* actual_predicate_value, + const char* expected_predicate_value); + +// This template class represents an IEEE floating-point number +// (either single-precision or double-precision, depending on the +// template parameters). +// +// The purpose of this class is to do more sophisticated number +// comparison. (Due to round-off error, etc, it's very unlikely that +// two floating-points will be equal exactly. Hence a naive +// comparison by the == operation often doesn't work.) +// +// Format of IEEE floating-point: +// +// The most-significant bit being the leftmost, an IEEE +// floating-point looks like +// +// sign_bit exponent_bits fraction_bits +// +// Here, sign_bit is a single bit that designates the sign of the +// number. +// +// For float, there are 8 exponent bits and 23 fraction bits. +// +// For double, there are 11 exponent bits and 52 fraction bits. +// +// More details can be found at +// http://en.wikipedia.org/wiki/IEEE_floating-point_standard. +// +// Template parameter: +// +// RawType: the raw floating-point type (either float or double) +template +class FloatingPoint { + public: + // Defines the unsigned integer type that has the same size as the + // floating point number. + typedef typename TypeWithSize::UInt Bits; + + // Constants. + + // # of bits in a number. + static const size_t kBitCount = 8*sizeof(RawType); + + // # of fraction bits in a number. + static const size_t kFractionBitCount = + std::numeric_limits::digits - 1; + + // # of exponent bits in a number. + static const size_t kExponentBitCount = kBitCount - 1 - kFractionBitCount; + + // The mask for the sign bit. + static const Bits kSignBitMask = static_cast(1) << (kBitCount - 1); + + // The mask for the fraction bits. + static const Bits kFractionBitMask = + ~static_cast(0) >> (kExponentBitCount + 1); + + // The mask for the exponent bits. + static const Bits kExponentBitMask = ~(kSignBitMask | kFractionBitMask); + + // How many ULP's (Units in the Last Place) we want to tolerate when + // comparing two numbers. The larger the value, the more error we + // allow. A 0 value means that two numbers must be exactly the same + // to be considered equal. + // + // The maximum error of a single floating-point operation is 0.5 + // units in the last place. On Intel CPU's, all floating-point + // calculations are done with 80-bit precision, while double has 64 + // bits. Therefore, 4 should be enough for ordinary use. + // + // See the following article for more details on ULP: + // http://www.cygnus-software.com/papers/comparingfloats/comparingfloats.htm. + static const size_t kMaxUlps = 4; + + // Constructs a FloatingPoint from a raw floating-point number. + // + // On an Intel CPU, passing a non-normalized NAN (Not a Number) + // around may change its bits, although the new value is guaranteed + // to be also a NAN. Therefore, don't expect this constructor to + // preserve the bits in x when x is a NAN. + explicit FloatingPoint(const RawType& x) { u_.value_ = x; } + + // Static methods + + // Reinterprets a bit pattern as a floating-point number. + // + // This function is needed to test the AlmostEquals() method. + static RawType ReinterpretBits(const Bits bits) { + FloatingPoint fp(0); + fp.u_.bits_ = bits; + return fp.u_.value_; + } + + // Returns the floating-point number that represent positive infinity. + static RawType Infinity() { + return ReinterpretBits(kExponentBitMask); + } + + // Non-static methods + + // Returns the bits that represents this number. + const Bits &bits() const { return u_.bits_; } + + // Returns the exponent bits of this number. + Bits exponent_bits() const { return kExponentBitMask & u_.bits_; } + + // Returns the fraction bits of this number. + Bits fraction_bits() const { return kFractionBitMask & u_.bits_; } + + // Returns the sign bit of this number. + Bits sign_bit() const { return kSignBitMask & u_.bits_; } + + // Returns true iff this is NAN (not a number). + bool is_nan() const { + // It's a NAN if the exponent bits are all ones and the fraction + // bits are not entirely zeros. + return (exponent_bits() == kExponentBitMask) && (fraction_bits() != 0); + } + + // Returns true iff this number is at most kMaxUlps ULP's away from + // rhs. In particular, this function: + // + // - returns false if either number is (or both are) NAN. + // - treats really large numbers as almost equal to infinity. + // - thinks +0.0 and -0.0 are 0 DLP's apart. + bool AlmostEquals(const FloatingPoint& rhs) const { + // The IEEE standard says that any comparison operation involving + // a NAN must return false. + if (is_nan() || rhs.is_nan()) return false; + + return DistanceBetweenSignAndMagnitudeNumbers(u_.bits_, rhs.u_.bits_) + <= kMaxUlps; + } + + private: + // The data type used to store the actual floating-point number. + union FloatingPointUnion { + RawType value_; // The raw floating-point number. + Bits bits_; // The bits that represent the number. + }; + + // Converts an integer from the sign-and-magnitude representation to + // the biased representation. More precisely, let N be 2 to the + // power of (kBitCount - 1), an integer x is represented by the + // unsigned number x + N. + // + // For instance, + // + // -N + 1 (the most negative number representable using + // sign-and-magnitude) is represented by 1; + // 0 is represented by N; and + // N - 1 (the biggest number representable using + // sign-and-magnitude) is represented by 2N - 1. + // + // Read http://en.wikipedia.org/wiki/Signed_number_representations + // for more details on signed number representations. + static Bits SignAndMagnitudeToBiased(const Bits &sam) { + if (kSignBitMask & sam) { + // sam represents a negative number. + return ~sam + 1; + } else { + // sam represents a positive number. + return kSignBitMask | sam; + } + } + + // Given two numbers in the sign-and-magnitude representation, + // returns the distance between them as an unsigned number. + static Bits DistanceBetweenSignAndMagnitudeNumbers(const Bits &sam1, + const Bits &sam2) { + const Bits biased1 = SignAndMagnitudeToBiased(sam1); + const Bits biased2 = SignAndMagnitudeToBiased(sam2); + return (biased1 >= biased2) ? (biased1 - biased2) : (biased2 - biased1); + } + + FloatingPointUnion u_; +}; + +// Typedefs the instances of the FloatingPoint template class that we +// care to use. +typedef FloatingPoint Float; +typedef FloatingPoint Double; + +// In order to catch the mistake of putting tests that use different +// test fixture classes in the same test case, we need to assign +// unique IDs to fixture classes and compare them. The TypeId type is +// used to hold such IDs. The user should treat TypeId as an opaque +// type: the only operation allowed on TypeId values is to compare +// them for equality using the == operator. +typedef const void* TypeId; + +template +class TypeIdHelper { + public: + // dummy_ must not have a const type. Otherwise an overly eager + // compiler (e.g. MSVC 7.1 & 8.0) may try to merge + // TypeIdHelper::dummy_ for different Ts as an "optimization". + static bool dummy_; +}; + +template +bool TypeIdHelper::dummy_ = false; + +// GetTypeId() returns the ID of type T. Different values will be +// returned for different types. Calling the function twice with the +// same type argument is guaranteed to return the same ID. +template +TypeId GetTypeId() { + // The compiler is required to allocate a different + // TypeIdHelper::dummy_ variable for each T used to instantiate + // the template. Therefore, the address of dummy_ is guaranteed to + // be unique. + return &(TypeIdHelper::dummy_); +} + +// Returns the type ID of ::testing::Test. Always call this instead +// of GetTypeId< ::testing::Test>() to get the type ID of +// ::testing::Test, as the latter may give the wrong result due to a +// suspected linker bug when compiling Google Test as a Mac OS X +// framework. +GTEST_API_ TypeId GetTestTypeId(); + +// Defines the abstract factory interface that creates instances +// of a Test object. +class TestFactoryBase { + public: + virtual ~TestFactoryBase() {} + + // Creates a test instance to run. The instance is both created and destroyed + // within TestInfoImpl::Run() + virtual Test* CreateTest() = 0; + + protected: + TestFactoryBase() {} + + private: + GTEST_DISALLOW_COPY_AND_ASSIGN_(TestFactoryBase); +}; + +// This class provides implementation of TeastFactoryBase interface. +// It is used in TEST and TEST_F macros. +template +class TestFactoryImpl : public TestFactoryBase { + public: + virtual Test* CreateTest() { return new TestClass; } +}; + +#if GTEST_OS_WINDOWS + +// Predicate-formatters for implementing the HRESULT checking macros +// {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED} +// We pass a long instead of HRESULT to avoid causing an +// include dependency for the HRESULT type. +GTEST_API_ AssertionResult IsHRESULTSuccess(const char* expr, + long hr); // NOLINT +GTEST_API_ AssertionResult IsHRESULTFailure(const char* expr, + long hr); // NOLINT + +#endif // GTEST_OS_WINDOWS + +// Types of SetUpTestCase() and TearDownTestCase() functions. +typedef void (*SetUpTestCaseFunc)(); +typedef void (*TearDownTestCaseFunc)(); + +// Creates a new TestInfo object and registers it with Google Test; +// returns the created object. +// +// Arguments: +// +// test_case_name: name of the test case +// name: name of the test +// type_param the name of the test's type parameter, or NULL if +// this is not a typed or a type-parameterized test. +// value_param text representation of the test's value parameter, +// or NULL if this is not a type-parameterized test. +// fixture_class_id: ID of the test fixture class +// set_up_tc: pointer to the function that sets up the test case +// tear_down_tc: pointer to the function that tears down the test case +// factory: pointer to the factory that creates a test object. +// The newly created TestInfo instance will assume +// ownership of the factory object. +GTEST_API_ TestInfo* MakeAndRegisterTestInfo( + const char* test_case_name, const char* name, + const char* type_param, + const char* value_param, + TypeId fixture_class_id, + SetUpTestCaseFunc set_up_tc, + TearDownTestCaseFunc tear_down_tc, + TestFactoryBase* factory); + +// If *pstr starts with the given prefix, modifies *pstr to be right +// past the prefix and returns true; otherwise leaves *pstr unchanged +// and returns false. None of pstr, *pstr, and prefix can be NULL. +GTEST_API_ bool SkipPrefix(const char* prefix, const char** pstr); + +#if GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P + +// State of the definition of a type-parameterized test case. +class GTEST_API_ TypedTestCasePState { + public: + TypedTestCasePState() : registered_(false) {} + + // Adds the given test name to defined_test_names_ and return true + // if the test case hasn't been registered; otherwise aborts the + // program. + bool AddTestName(const char* file, int line, const char* case_name, + const char* test_name) { + if (registered_) { + fprintf(stderr, "%s Test %s must be defined before " + "REGISTER_TYPED_TEST_CASE_P(%s, ...).\n", + FormatFileLocation(file, line).c_str(), test_name, case_name); + fflush(stderr); + posix::Abort(); + } + defined_test_names_.insert(test_name); + return true; + } + + // Verifies that registered_tests match the test names in + // defined_test_names_; returns registered_tests if successful, or + // aborts the program otherwise. + const char* VerifyRegisteredTestNames( + const char* file, int line, const char* registered_tests); + + private: + bool registered_; + ::std::set defined_test_names_; +}; + +// Skips to the first non-space char after the first comma in 'str'; +// returns NULL if no comma is found in 'str'. +inline const char* SkipComma(const char* str) { + const char* comma = strchr(str, ','); + if (comma == NULL) { + return NULL; + } + while (IsSpace(*(++comma))) {} + return comma; +} + +// Returns the prefix of 'str' before the first comma in it; returns +// the entire string if it contains no comma. +inline String GetPrefixUntilComma(const char* str) { + const char* comma = strchr(str, ','); + return comma == NULL ? String(str) : String(str, comma - str); +} + +// TypeParameterizedTest::Register() +// registers a list of type-parameterized tests with Google Test. The +// return value is insignificant - we just need to return something +// such that we can call this function in a namespace scope. +// +// Implementation note: The GTEST_TEMPLATE_ macro declares a template +// template parameter. It's defined in gtest-type-util.h. +template +class TypeParameterizedTest { + public: + // 'index' is the index of the test in the type list 'Types' + // specified in INSTANTIATE_TYPED_TEST_CASE_P(Prefix, TestCase, + // Types). Valid values for 'index' are [0, N - 1] where N is the + // length of Types. + static bool Register(const char* prefix, const char* case_name, + const char* test_names, int index) { + typedef typename Types::Head Type; + typedef Fixture FixtureClass; + typedef typename GTEST_BIND_(TestSel, Type) TestClass; + + // First, registers the first type-parameterized test in the type + // list. + MakeAndRegisterTestInfo( + String::Format("%s%s%s/%d", prefix, prefix[0] == '\0' ? "" : "/", + case_name, index).c_str(), + GetPrefixUntilComma(test_names).c_str(), + GetTypeName().c_str(), + NULL, // No value parameter. + GetTypeId(), + TestClass::SetUpTestCase, + TestClass::TearDownTestCase, + new TestFactoryImpl); + + // Next, recurses (at compile time) with the tail of the type list. + return TypeParameterizedTest + ::Register(prefix, case_name, test_names, index + 1); + } +}; + +// The base case for the compile time recursion. +template +class TypeParameterizedTest { + public: + static bool Register(const char* /*prefix*/, const char* /*case_name*/, + const char* /*test_names*/, int /*index*/) { + return true; + } +}; + +// TypeParameterizedTestCase::Register() +// registers *all combinations* of 'Tests' and 'Types' with Google +// Test. The return value is insignificant - we just need to return +// something such that we can call this function in a namespace scope. +template +class TypeParameterizedTestCase { + public: + static bool Register(const char* prefix, const char* case_name, + const char* test_names) { + typedef typename Tests::Head Head; + + // First, register the first test in 'Test' for each type in 'Types'. + TypeParameterizedTest::Register( + prefix, case_name, test_names, 0); + + // Next, recurses (at compile time) with the tail of the test list. + return TypeParameterizedTestCase + ::Register(prefix, case_name, SkipComma(test_names)); + } +}; + +// The base case for the compile time recursion. +template +class TypeParameterizedTestCase { + public: + static bool Register(const char* /*prefix*/, const char* /*case_name*/, + const char* /*test_names*/) { + return true; + } +}; + +#endif // GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P + +// Returns the current OS stack trace as a String. +// +// The maximum number of stack frames to be included is specified by +// the gtest_stack_trace_depth flag. The skip_count parameter +// specifies the number of top frames to be skipped, which doesn't +// count against the number of frames to be included. +// +// For example, if Foo() calls Bar(), which in turn calls +// GetCurrentOsStackTraceExceptTop(..., 1), Foo() will be included in +// the trace but Bar() and GetCurrentOsStackTraceExceptTop() won't. +GTEST_API_ String GetCurrentOsStackTraceExceptTop(UnitTest* unit_test, + int skip_count); + +// Helpers for suppressing warnings on unreachable code or constant +// condition. + +// Always returns true. +GTEST_API_ bool AlwaysTrue(); + +// Always returns false. +inline bool AlwaysFalse() { return !AlwaysTrue(); } + +// Helper for suppressing false warning from Clang on a const char* +// variable declared in a conditional expression always being NULL in +// the else branch. +struct GTEST_API_ ConstCharPtr { + ConstCharPtr(const char* str) : value(str) {} + operator bool() const { return true; } + const char* value; +}; + +// A simple Linear Congruential Generator for generating random +// numbers with a uniform distribution. Unlike rand() and srand(), it +// doesn't use global state (and therefore can't interfere with user +// code). Unlike rand_r(), it's portable. An LCG isn't very random, +// but it's good enough for our purposes. +class GTEST_API_ Random { + public: + static const UInt32 kMaxRange = 1u << 31; + + explicit Random(UInt32 seed) : state_(seed) {} + + void Reseed(UInt32 seed) { state_ = seed; } + + // Generates a random number from [0, range). Crashes if 'range' is + // 0 or greater than kMaxRange. + UInt32 Generate(UInt32 range); + + private: + UInt32 state_; + GTEST_DISALLOW_COPY_AND_ASSIGN_(Random); +}; + +// Defining a variable of type CompileAssertTypesEqual will cause a +// compiler error iff T1 and T2 are different types. +template +struct CompileAssertTypesEqual; + +template +struct CompileAssertTypesEqual { +}; + +// Removes the reference from a type if it is a reference type, +// otherwise leaves it unchanged. This is the same as +// tr1::remove_reference, which is not widely available yet. +template +struct RemoveReference { typedef T type; }; // NOLINT +template +struct RemoveReference { typedef T type; }; // NOLINT + +// A handy wrapper around RemoveReference that works when the argument +// T depends on template parameters. +#define GTEST_REMOVE_REFERENCE_(T) \ + typename ::testing::internal::RemoveReference::type + +// Removes const from a type if it is a const type, otherwise leaves +// it unchanged. This is the same as tr1::remove_const, which is not +// widely available yet. +template +struct RemoveConst { typedef T type; }; // NOLINT +template +struct RemoveConst { typedef T type; }; // NOLINT + +// MSVC 8.0, Sun C++, and IBM XL C++ have a bug which causes the above +// definition to fail to remove the const in 'const int[3]' and 'const +// char[3][4]'. The following specialization works around the bug. +// However, it causes trouble with GCC and thus needs to be +// conditionally compiled. +#if defined(_MSC_VER) || defined(__SUNPRO_CC) || defined(__IBMCPP__) +template +struct RemoveConst { + typedef typename RemoveConst::type type[N]; +}; +#endif + +// A handy wrapper around RemoveConst that works when the argument +// T depends on template parameters. +#define GTEST_REMOVE_CONST_(T) \ + typename ::testing::internal::RemoveConst::type + +// Turns const U&, U&, const U, and U all into U. +#define GTEST_REMOVE_REFERENCE_AND_CONST_(T) \ + GTEST_REMOVE_CONST_(GTEST_REMOVE_REFERENCE_(T)) + +// Adds reference to a type if it is not a reference type, +// otherwise leaves it unchanged. This is the same as +// tr1::add_reference, which is not widely available yet. +template +struct AddReference { typedef T& type; }; // NOLINT +template +struct AddReference { typedef T& type; }; // NOLINT + +// A handy wrapper around AddReference that works when the argument T +// depends on template parameters. +#define GTEST_ADD_REFERENCE_(T) \ + typename ::testing::internal::AddReference::type + +// Adds a reference to const on top of T as necessary. For example, +// it transforms +// +// char ==> const char& +// const char ==> const char& +// char& ==> const char& +// const char& ==> const char& +// +// The argument T must depend on some template parameters. +#define GTEST_REFERENCE_TO_CONST_(T) \ + GTEST_ADD_REFERENCE_(const GTEST_REMOVE_REFERENCE_(T)) + +// ImplicitlyConvertible::value is a compile-time bool +// constant that's true iff type From can be implicitly converted to +// type To. +template +class ImplicitlyConvertible { + private: + // We need the following helper functions only for their types. + // They have no implementations. + + // MakeFrom() is an expression whose type is From. We cannot simply + // use From(), as the type From may not have a public default + // constructor. + static From MakeFrom(); + + // These two functions are overloaded. Given an expression + // Helper(x), the compiler will pick the first version if x can be + // implicitly converted to type To; otherwise it will pick the + // second version. + // + // The first version returns a value of size 1, and the second + // version returns a value of size 2. Therefore, by checking the + // size of Helper(x), which can be done at compile time, we can tell + // which version of Helper() is used, and hence whether x can be + // implicitly converted to type To. + static char Helper(To); + static char (&Helper(...))[2]; // NOLINT + + // We have to put the 'public' section after the 'private' section, + // or MSVC refuses to compile the code. + public: + // MSVC warns about implicitly converting from double to int for + // possible loss of data, so we need to temporarily disable the + // warning. +#ifdef _MSC_VER +# pragma warning(push) // Saves the current warning state. +# pragma warning(disable:4244) // Temporarily disables warning 4244. + + static const bool value = + sizeof(Helper(ImplicitlyConvertible::MakeFrom())) == 1; +# pragma warning(pop) // Restores the warning state. +#elif defined(__BORLANDC__) + // C++Builder cannot use member overload resolution during template + // instantiation. The simplest workaround is to use its C++0x type traits + // functions (C++Builder 2009 and above only). + static const bool value = __is_convertible(From, To); +#else + static const bool value = + sizeof(Helper(ImplicitlyConvertible::MakeFrom())) == 1; +#endif // _MSV_VER +}; +template +const bool ImplicitlyConvertible::value; + +// IsAProtocolMessage::value is a compile-time bool constant that's +// true iff T is type ProtocolMessage, proto2::Message, or a subclass +// of those. +template +struct IsAProtocolMessage + : public bool_constant< + ImplicitlyConvertible::value || + ImplicitlyConvertible::value> { +}; + +// When the compiler sees expression IsContainerTest(0), if C is an +// STL-style container class, the first overload of IsContainerTest +// will be viable (since both C::iterator* and C::const_iterator* are +// valid types and NULL can be implicitly converted to them). It will +// be picked over the second overload as 'int' is a perfect match for +// the type of argument 0. If C::iterator or C::const_iterator is not +// a valid type, the first overload is not viable, and the second +// overload will be picked. Therefore, we can determine whether C is +// a container class by checking the type of IsContainerTest(0). +// The value of the expression is insignificant. +// +// Note that we look for both C::iterator and C::const_iterator. The +// reason is that C++ injects the name of a class as a member of the +// class itself (e.g. you can refer to class iterator as either +// 'iterator' or 'iterator::iterator'). If we look for C::iterator +// only, for example, we would mistakenly think that a class named +// iterator is an STL container. +// +// Also note that the simpler approach of overloading +// IsContainerTest(typename C::const_iterator*) and +// IsContainerTest(...) doesn't work with Visual Age C++ and Sun C++. +typedef int IsContainer; +template +IsContainer IsContainerTest(int /* dummy */, + typename C::iterator* /* it */ = NULL, + typename C::const_iterator* /* const_it */ = NULL) { + return 0; +} + +typedef char IsNotContainer; +template +IsNotContainer IsContainerTest(long /* dummy */) { return '\0'; } + +// EnableIf::type is void when 'Cond' is true, and +// undefined when 'Cond' is false. To use SFINAE to make a function +// overload only apply when a particular expression is true, add +// "typename EnableIf::type* = 0" as the last parameter. +template struct EnableIf; +template<> struct EnableIf { typedef void type; }; // NOLINT + +// Utilities for native arrays. + +// ArrayEq() compares two k-dimensional native arrays using the +// elements' operator==, where k can be any integer >= 0. When k is +// 0, ArrayEq() degenerates into comparing a single pair of values. + +template +bool ArrayEq(const T* lhs, size_t size, const U* rhs); + +// This generic version is used when k is 0. +template +inline bool ArrayEq(const T& lhs, const U& rhs) { return lhs == rhs; } + +// This overload is used when k >= 1. +template +inline bool ArrayEq(const T(&lhs)[N], const U(&rhs)[N]) { + return internal::ArrayEq(lhs, N, rhs); +} + +// This helper reduces code bloat. If we instead put its logic inside +// the previous ArrayEq() function, arrays with different sizes would +// lead to different copies of the template code. +template +bool ArrayEq(const T* lhs, size_t size, const U* rhs) { + for (size_t i = 0; i != size; i++) { + if (!internal::ArrayEq(lhs[i], rhs[i])) + return false; + } + return true; +} + +// Finds the first element in the iterator range [begin, end) that +// equals elem. Element may be a native array type itself. +template +Iter ArrayAwareFind(Iter begin, Iter end, const Element& elem) { + for (Iter it = begin; it != end; ++it) { + if (internal::ArrayEq(*it, elem)) + return it; + } + return end; +} + +// CopyArray() copies a k-dimensional native array using the elements' +// operator=, where k can be any integer >= 0. When k is 0, +// CopyArray() degenerates into copying a single value. + +template +void CopyArray(const T* from, size_t size, U* to); + +// This generic version is used when k is 0. +template +inline void CopyArray(const T& from, U* to) { *to = from; } + +// This overload is used when k >= 1. +template +inline void CopyArray(const T(&from)[N], U(*to)[N]) { + internal::CopyArray(from, N, *to); +} + +// This helper reduces code bloat. If we instead put its logic inside +// the previous CopyArray() function, arrays with different sizes +// would lead to different copies of the template code. +template +void CopyArray(const T* from, size_t size, U* to) { + for (size_t i = 0; i != size; i++) { + internal::CopyArray(from[i], to + i); + } +} + +// The relation between an NativeArray object (see below) and the +// native array it represents. +enum RelationToSource { + kReference, // The NativeArray references the native array. + kCopy // The NativeArray makes a copy of the native array and + // owns the copy. +}; + +// Adapts a native array to a read-only STL-style container. Instead +// of the complete STL container concept, this adaptor only implements +// members useful for Google Mock's container matchers. New members +// should be added as needed. To simplify the implementation, we only +// support Element being a raw type (i.e. having no top-level const or +// reference modifier). It's the client's responsibility to satisfy +// this requirement. Element can be an array type itself (hence +// multi-dimensional arrays are supported). +template +class NativeArray { + public: + // STL-style container typedefs. + typedef Element value_type; + typedef Element* iterator; + typedef const Element* const_iterator; + + // Constructs from a native array. + NativeArray(const Element* array, size_t count, RelationToSource relation) { + Init(array, count, relation); + } + + // Copy constructor. + NativeArray(const NativeArray& rhs) { + Init(rhs.array_, rhs.size_, rhs.relation_to_source_); + } + + ~NativeArray() { + // Ensures that the user doesn't instantiate NativeArray with a + // const or reference type. + static_cast(StaticAssertTypeEqHelper()); + if (relation_to_source_ == kCopy) + delete[] array_; + } + + // STL-style container methods. + size_t size() const { return size_; } + const_iterator begin() const { return array_; } + const_iterator end() const { return array_ + size_; } + bool operator==(const NativeArray& rhs) const { + return size() == rhs.size() && + ArrayEq(begin(), size(), rhs.begin()); + } + + private: + // Initializes this object; makes a copy of the input array if + // 'relation' is kCopy. + void Init(const Element* array, size_t a_size, RelationToSource relation) { + if (relation == kReference) { + array_ = array; + } else { + Element* const copy = new Element[a_size]; + CopyArray(array, a_size, copy); + array_ = copy; + } + size_ = a_size; + relation_to_source_ = relation; + } + + const Element* array_; + size_t size_; + RelationToSource relation_to_source_; + + GTEST_DISALLOW_ASSIGN_(NativeArray); +}; + +} // namespace internal +} // namespace testing + +#define GTEST_MESSAGE_AT_(file, line, message, result_type) \ + ::testing::internal::AssertHelper(result_type, file, line, message) \ + = ::testing::Message() + +#define GTEST_MESSAGE_(message, result_type) \ + GTEST_MESSAGE_AT_(__FILE__, __LINE__, message, result_type) + +#define GTEST_FATAL_FAILURE_(message) \ + return GTEST_MESSAGE_(message, ::testing::TestPartResult::kFatalFailure) + +#define GTEST_NONFATAL_FAILURE_(message) \ + GTEST_MESSAGE_(message, ::testing::TestPartResult::kNonFatalFailure) + +#define GTEST_SUCCESS_(message) \ + GTEST_MESSAGE_(message, ::testing::TestPartResult::kSuccess) + +// Suppresses MSVC warnings 4072 (unreachable code) for the code following +// statement if it returns or throws (or doesn't return or throw in some +// situations). +#define GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement) \ + if (::testing::internal::AlwaysTrue()) { statement; } + +#define GTEST_TEST_THROW_(statement, expected_exception, fail) \ + GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ + if (::testing::internal::ConstCharPtr gtest_msg = "") { \ + bool gtest_caught_expected = false; \ + try { \ + GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ + } \ + catch (expected_exception const&) { \ + gtest_caught_expected = true; \ + } \ + catch (...) { \ + gtest_msg.value = \ + "Expected: " #statement " throws an exception of type " \ + #expected_exception ".\n Actual: it throws a different type."; \ + goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \ + } \ + if (!gtest_caught_expected) { \ + gtest_msg.value = \ + "Expected: " #statement " throws an exception of type " \ + #expected_exception ".\n Actual: it throws nothing."; \ + goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \ + } \ + } else \ + GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__): \ + fail(gtest_msg.value) + +#define GTEST_TEST_NO_THROW_(statement, fail) \ + GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ + if (::testing::internal::AlwaysTrue()) { \ + try { \ + GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ + } \ + catch (...) { \ + goto GTEST_CONCAT_TOKEN_(gtest_label_testnothrow_, __LINE__); \ + } \ + } else \ + GTEST_CONCAT_TOKEN_(gtest_label_testnothrow_, __LINE__): \ + fail("Expected: " #statement " doesn't throw an exception.\n" \ + " Actual: it throws.") + +#define GTEST_TEST_ANY_THROW_(statement, fail) \ + GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ + if (::testing::internal::AlwaysTrue()) { \ + bool gtest_caught_any = false; \ + try { \ + GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ + } \ + catch (...) { \ + gtest_caught_any = true; \ + } \ + if (!gtest_caught_any) { \ + goto GTEST_CONCAT_TOKEN_(gtest_label_testanythrow_, __LINE__); \ + } \ + } else \ + GTEST_CONCAT_TOKEN_(gtest_label_testanythrow_, __LINE__): \ + fail("Expected: " #statement " throws an exception.\n" \ + " Actual: it doesn't.") + + +// Implements Boolean test assertions such as EXPECT_TRUE. expression can be +// either a boolean expression or an AssertionResult. text is a textual +// represenation of expression as it was passed into the EXPECT_TRUE. +#define GTEST_TEST_BOOLEAN_(expression, text, actual, expected, fail) \ + GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ + if (const ::testing::AssertionResult gtest_ar_ = \ + ::testing::AssertionResult(expression)) \ + ; \ + else \ + fail(::testing::internal::GetBoolAssertionFailureMessage(\ + gtest_ar_, text, #actual, #expected).c_str()) + +#define GTEST_TEST_NO_FATAL_FAILURE_(statement, fail) \ + GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ + if (::testing::internal::AlwaysTrue()) { \ + ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker; \ + GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ + if (gtest_fatal_failure_checker.has_new_fatal_failure()) { \ + goto GTEST_CONCAT_TOKEN_(gtest_label_testnofatal_, __LINE__); \ + } \ + } else \ + GTEST_CONCAT_TOKEN_(gtest_label_testnofatal_, __LINE__): \ + fail("Expected: " #statement " doesn't generate new fatal " \ + "failures in the current thread.\n" \ + " Actual: it does.") + +// Expands to the name of the class that implements the given test. +#define GTEST_TEST_CLASS_NAME_(test_case_name, test_name) \ + test_case_name##_##test_name##_Test + +// Helper macro for defining tests. +#define GTEST_TEST_(test_case_name, test_name, parent_class, parent_id)\ +class GTEST_TEST_CLASS_NAME_(test_case_name, test_name) : public parent_class {\ + public:\ + GTEST_TEST_CLASS_NAME_(test_case_name, test_name)() {}\ + private:\ + virtual void TestBody();\ + static ::testing::TestInfo* const test_info_ GTEST_ATTRIBUTE_UNUSED_;\ + GTEST_DISALLOW_COPY_AND_ASSIGN_(\ + GTEST_TEST_CLASS_NAME_(test_case_name, test_name));\ +};\ +\ +::testing::TestInfo* const GTEST_TEST_CLASS_NAME_(test_case_name, test_name)\ + ::test_info_ =\ + ::testing::internal::MakeAndRegisterTestInfo(\ + #test_case_name, #test_name, NULL, NULL, \ + (parent_id), \ + parent_class::SetUpTestCase, \ + parent_class::TearDownTestCase, \ + new ::testing::internal::TestFactoryImpl<\ + GTEST_TEST_CLASS_NAME_(test_case_name, test_name)>);\ +void GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::TestBody() + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-linked_ptr.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-linked_ptr.h new file mode 100644 index 0000000000..67dfc4c4fb --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-linked_ptr.h @@ -0,0 +1,233 @@ +// Copyright 2003 Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Authors: Dan Egnor (egnor@google.com) +// +// A "smart" pointer type with reference tracking. Every pointer to a +// particular object is kept on a circular linked list. When the last pointer +// to an object is destroyed or reassigned, the object is deleted. +// +// Used properly, this deletes the object when the last reference goes away. +// There are several caveats: +// - Like all reference counting schemes, cycles lead to leaks. +// - Each smart pointer is actually two pointers (8 bytes instead of 4). +// - Every time a pointer is assigned, the entire list of pointers to that +// object is traversed. This class is therefore NOT SUITABLE when there +// will often be more than two or three pointers to a particular object. +// - References are only tracked as long as linked_ptr<> objects are copied. +// If a linked_ptr<> is converted to a raw pointer and back, BAD THINGS +// will happen (double deletion). +// +// A good use of this class is storing object references in STL containers. +// You can safely put linked_ptr<> in a vector<>. +// Other uses may not be as good. +// +// Note: If you use an incomplete type with linked_ptr<>, the class +// *containing* linked_ptr<> must have a constructor and destructor (even +// if they do nothing!). +// +// Bill Gibbons suggested we use something like this. +// +// Thread Safety: +// Unlike other linked_ptr implementations, in this implementation +// a linked_ptr object is thread-safe in the sense that: +// - it's safe to copy linked_ptr objects concurrently, +// - it's safe to copy *from* a linked_ptr and read its underlying +// raw pointer (e.g. via get()) concurrently, and +// - it's safe to write to two linked_ptrs that point to the same +// shared object concurrently. +// TODO(wan@google.com): rename this to safe_linked_ptr to avoid +// confusion with normal linked_ptr. + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_LINKED_PTR_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_LINKED_PTR_H_ + +#include +#include + +#include "gtest/internal/gtest-port.h" + +namespace testing { +namespace internal { + +// Protects copying of all linked_ptr objects. +GTEST_API_ GTEST_DECLARE_STATIC_MUTEX_(g_linked_ptr_mutex); + +// This is used internally by all instances of linked_ptr<>. It needs to be +// a non-template class because different types of linked_ptr<> can refer to +// the same object (linked_ptr(obj) vs linked_ptr(obj)). +// So, it needs to be possible for different types of linked_ptr to participate +// in the same circular linked list, so we need a single class type here. +// +// DO NOT USE THIS CLASS DIRECTLY YOURSELF. Use linked_ptr. +class linked_ptr_internal { + public: + // Create a new circle that includes only this instance. + void join_new() { + next_ = this; + } + + // Many linked_ptr operations may change p.link_ for some linked_ptr + // variable p in the same circle as this object. Therefore we need + // to prevent two such operations from occurring concurrently. + // + // Note that different types of linked_ptr objects can coexist in a + // circle (e.g. linked_ptr, linked_ptr, and + // linked_ptr). Therefore we must use a single mutex to + // protect all linked_ptr objects. This can create serious + // contention in production code, but is acceptable in a testing + // framework. + + // Join an existing circle. + // L < g_linked_ptr_mutex + void join(linked_ptr_internal const* ptr) { + MutexLock lock(&g_linked_ptr_mutex); + + linked_ptr_internal const* p = ptr; + while (p->next_ != ptr) p = p->next_; + p->next_ = this; + next_ = ptr; + } + + // Leave whatever circle we're part of. Returns true if we were the + // last member of the circle. Once this is done, you can join() another. + // L < g_linked_ptr_mutex + bool depart() { + MutexLock lock(&g_linked_ptr_mutex); + + if (next_ == this) return true; + linked_ptr_internal const* p = next_; + while (p->next_ != this) p = p->next_; + p->next_ = next_; + return false; + } + + private: + mutable linked_ptr_internal const* next_; +}; + +template +class linked_ptr { + public: + typedef T element_type; + + // Take over ownership of a raw pointer. This should happen as soon as + // possible after the object is created. + explicit linked_ptr(T* ptr = NULL) { capture(ptr); } + ~linked_ptr() { depart(); } + + // Copy an existing linked_ptr<>, adding ourselves to the list of references. + template linked_ptr(linked_ptr const& ptr) { copy(&ptr); } + linked_ptr(linked_ptr const& ptr) { // NOLINT + assert(&ptr != this); + copy(&ptr); + } + + // Assignment releases the old value and acquires the new. + template linked_ptr& operator=(linked_ptr const& ptr) { + depart(); + copy(&ptr); + return *this; + } + + linked_ptr& operator=(linked_ptr const& ptr) { + if (&ptr != this) { + depart(); + copy(&ptr); + } + return *this; + } + + // Smart pointer members. + void reset(T* ptr = NULL) { + depart(); + capture(ptr); + } + T* get() const { return value_; } + T* operator->() const { return value_; } + T& operator*() const { return *value_; } + + bool operator==(T* p) const { return value_ == p; } + bool operator!=(T* p) const { return value_ != p; } + template + bool operator==(linked_ptr const& ptr) const { + return value_ == ptr.get(); + } + template + bool operator!=(linked_ptr const& ptr) const { + return value_ != ptr.get(); + } + + private: + template + friend class linked_ptr; + + T* value_; + linked_ptr_internal link_; + + void depart() { + if (link_.depart()) delete value_; + } + + void capture(T* ptr) { + value_ = ptr; + link_.join_new(); + } + + template void copy(linked_ptr const* ptr) { + value_ = ptr->get(); + if (value_) + link_.join(&ptr->link_); + else + link_.join_new(); + } +}; + +template inline +bool operator==(T* ptr, const linked_ptr& x) { + return ptr == x.get(); +} + +template inline +bool operator!=(T* ptr, const linked_ptr& x) { + return ptr != x.get(); +} + +// A function to convert T* into linked_ptr +// Doing e.g. make_linked_ptr(new FooBarBaz(arg)) is a shorter notation +// for linked_ptr >(new FooBarBaz(arg)) +template +linked_ptr make_linked_ptr(T* ptr) { + return linked_ptr(ptr); +} + +} // namespace internal +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_LINKED_PTR_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util-generated.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util-generated.h new file mode 100644 index 0000000000..c29bf1dcd0 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util-generated.h @@ -0,0 +1,4822 @@ +// This file was GENERATED by command: +// pump.py gtest-param-util-generated.h.pump +// DO NOT EDIT BY HAND!!! + +// Copyright 2008 Google Inc. +// All Rights Reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: vladl@google.com (Vlad Losev) + +// Type and function utilities for implementing parameterized tests. +// This file is generated by a SCRIPT. DO NOT EDIT BY HAND! +// +// Currently Google Test supports at most 50 arguments in Values, +// and at most 10 arguments in Combine. Please contact +// googletestframework@googlegroups.com if you need more. +// Please note that the number of arguments to Combine is limited +// by the maximum arity of the implementation of tr1::tuple which is +// currently set at 10. + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_GENERATED_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_GENERATED_H_ + +// scripts/fuse_gtest.py depends on gtest's own header being #included +// *unconditionally*. Therefore these #includes cannot be moved +// inside #if GTEST_HAS_PARAM_TEST. +#include "gtest/internal/gtest-param-util.h" +#include "gtest/internal/gtest-port.h" + +#if GTEST_HAS_PARAM_TEST + +namespace testing { + +// Forward declarations of ValuesIn(), which is implemented in +// include/gtest/gtest-param-test.h. +template +internal::ParamGenerator< + typename ::testing::internal::IteratorTraits::value_type> +ValuesIn(ForwardIterator begin, ForwardIterator end); + +template +internal::ParamGenerator ValuesIn(const T (&array)[N]); + +template +internal::ParamGenerator ValuesIn( + const Container& container); + +namespace internal { + +// Used in the Values() function to provide polymorphic capabilities. +template +class ValueArray1 { + public: + explicit ValueArray1(T1 v1) : v1_(v1) {} + + template + operator ParamGenerator() const { return ValuesIn(&v1_, &v1_ + 1); } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray1& other); + + const T1 v1_; +}; + +template +class ValueArray2 { + public: + ValueArray2(T1 v1, T2 v2) : v1_(v1), v2_(v2) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray2& other); + + const T1 v1_; + const T2 v2_; +}; + +template +class ValueArray3 { + public: + ValueArray3(T1 v1, T2 v2, T3 v3) : v1_(v1), v2_(v2), v3_(v3) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray3& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; +}; + +template +class ValueArray4 { + public: + ValueArray4(T1 v1, T2 v2, T3 v3, T4 v4) : v1_(v1), v2_(v2), v3_(v3), + v4_(v4) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray4& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; +}; + +template +class ValueArray5 { + public: + ValueArray5(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5) : v1_(v1), v2_(v2), v3_(v3), + v4_(v4), v5_(v5) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray5& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; +}; + +template +class ValueArray6 { + public: + ValueArray6(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6) : v1_(v1), v2_(v2), + v3_(v3), v4_(v4), v5_(v5), v6_(v6) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray6& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; +}; + +template +class ValueArray7 { + public: + ValueArray7(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7) : v1_(v1), + v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray7& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; +}; + +template +class ValueArray8 { + public: + ValueArray8(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, + T8 v8) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray8& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; +}; + +template +class ValueArray9 { + public: + ValueArray9(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, + T9 v9) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray9& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; +}; + +template +class ValueArray10 { + public: + ValueArray10(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9), v10_(v10) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray10& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; +}; + +template +class ValueArray11 { + public: + ValueArray11(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), + v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray11& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; +}; + +template +class ValueArray12 { + public: + ValueArray12(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), + v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray12& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; +}; + +template +class ValueArray13 { + public: + ValueArray13(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), + v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), + v12_(v12), v13_(v13) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray13& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; +}; + +template +class ValueArray14 { + public: + ValueArray14(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14) : v1_(v1), v2_(v2), v3_(v3), + v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), + v11_(v11), v12_(v12), v13_(v13), v14_(v14) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray14& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; +}; + +template +class ValueArray15 { + public: + ValueArray15(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15) : v1_(v1), v2_(v2), + v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), + v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray15& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; +}; + +template +class ValueArray16 { + public: + ValueArray16(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16) : v1_(v1), + v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), + v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), + v16_(v16) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray16& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; +}; + +template +class ValueArray17 { + public: + ValueArray17(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, + T17 v17) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), + v15_(v15), v16_(v16), v17_(v17) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray17& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; +}; + +template +class ValueArray18 { + public: + ValueArray18(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), + v15_(v15), v16_(v16), v17_(v17), v18_(v18) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray18& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; +}; + +template +class ValueArray19 { + public: + ValueArray19(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), + v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), + v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray19& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; +}; + +template +class ValueArray20 { + public: + ValueArray20(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), + v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), + v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), + v19_(v19), v20_(v20) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray20& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; +}; + +template +class ValueArray21 { + public: + ValueArray21(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), + v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), + v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), + v18_(v18), v19_(v19), v20_(v20), v21_(v21) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray21& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; +}; + +template +class ValueArray22 { + public: + ValueArray22(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22) : v1_(v1), v2_(v2), v3_(v3), + v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), + v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), + v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray22& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; +}; + +template +class ValueArray23 { + public: + ValueArray23(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23) : v1_(v1), v2_(v2), + v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), + v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), + v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), + v23_(v23) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, + v23_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray23& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; +}; + +template +class ValueArray24 { + public: + ValueArray24(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24) : v1_(v1), + v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), + v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), + v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), + v22_(v22), v23_(v23), v24_(v24) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray24& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; +}; + +template +class ValueArray25 { + public: + ValueArray25(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, + T25 v25) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), + v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), + v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray25& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; +}; + +template +class ValueArray26 { + public: + ValueArray26(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), + v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), + v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray26& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; +}; + +template +class ValueArray27 { + public: + ValueArray27(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), + v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), + v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), + v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), + v26_(v26), v27_(v27) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray27& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; +}; + +template +class ValueArray28 { + public: + ValueArray28(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), + v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), + v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), + v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24), + v25_(v25), v26_(v26), v27_(v27), v28_(v28) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray28& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; +}; + +template +class ValueArray29 { + public: + ValueArray29(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), + v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), + v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), + v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23), + v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), v29_(v29) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray29& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; +}; + +template +class ValueArray30 { + public: + ValueArray30(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30) : v1_(v1), v2_(v2), v3_(v3), + v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), + v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), + v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), + v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), + v29_(v29), v30_(v30) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray30& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; +}; + +template +class ValueArray31 { + public: + ValueArray31(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31) : v1_(v1), v2_(v2), + v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), + v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), + v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), + v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), + v29_(v29), v30_(v30), v31_(v31) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray31& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; +}; + +template +class ValueArray32 { + public: + ValueArray32(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32) : v1_(v1), + v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), + v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), + v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), + v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), + v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray32& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; +}; + +template +class ValueArray33 { + public: + ValueArray33(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, + T33 v33) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), + v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), + v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), + v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32), + v33_(v33) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray33& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; +}; + +template +class ValueArray34 { + public: + ValueArray34(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), + v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), + v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), + v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32), + v33_(v33), v34_(v34) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray34& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; +}; + +template +class ValueArray35 { + public: + ValueArray35(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), + v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), + v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), + v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), + v26_(v26), v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), + v32_(v32), v33_(v33), v34_(v34), v35_(v35) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, + v35_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray35& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; +}; + +template +class ValueArray36 { + public: + ValueArray36(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), + v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), + v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), + v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24), + v25_(v25), v26_(v26), v27_(v27), v28_(v28), v29_(v29), v30_(v30), + v31_(v31), v32_(v32), v33_(v33), v34_(v34), v35_(v35), v36_(v36) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray36& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; +}; + +template +class ValueArray37 { + public: + ValueArray37(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), + v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), + v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), + v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23), + v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), v29_(v29), + v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34), v35_(v35), + v36_(v36), v37_(v37) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray37& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; +}; + +template +class ValueArray38 { + public: + ValueArray38(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38) : v1_(v1), v2_(v2), v3_(v3), + v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), + v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), + v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), + v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), + v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34), + v35_(v35), v36_(v36), v37_(v37), v38_(v38) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray38& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; +}; + +template +class ValueArray39 { + public: + ValueArray39(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39) : v1_(v1), v2_(v2), + v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), + v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), + v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), + v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), + v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34), + v35_(v35), v36_(v36), v37_(v37), v38_(v38), v39_(v39) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray39& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; +}; + +template +class ValueArray40 { + public: + ValueArray40(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40) : v1_(v1), + v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), + v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), + v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), + v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), + v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33), + v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38), v39_(v39), + v40_(v40) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_, v40_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray40& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; + const T40 v40_; +}; + +template +class ValueArray41 { + public: + ValueArray41(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, + T41 v41) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), + v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), + v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), + v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32), + v33_(v33), v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38), + v39_(v39), v40_(v40), v41_(v41) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_, v40_, v41_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray41& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; + const T40 v40_; + const T41 v41_; +}; + +template +class ValueArray42 { + public: + ValueArray42(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), + v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), + v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), + v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32), + v33_(v33), v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38), + v39_(v39), v40_(v40), v41_(v41), v42_(v42) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_, v40_, v41_, v42_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray42& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; + const T40 v40_; + const T41 v41_; + const T42 v42_; +}; + +template +class ValueArray43 { + public: + ValueArray43(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42, T43 v43) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), + v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), + v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), + v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), + v26_(v26), v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), + v32_(v32), v33_(v33), v34_(v34), v35_(v35), v36_(v36), v37_(v37), + v38_(v38), v39_(v39), v40_(v40), v41_(v41), v42_(v42), v43_(v43) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_, v40_, v41_, v42_, v43_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray43& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; + const T40 v40_; + const T41 v41_; + const T42 v42_; + const T43 v43_; +}; + +template +class ValueArray44 { + public: + ValueArray44(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42, T43 v43, T44 v44) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), + v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), + v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), + v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24), + v25_(v25), v26_(v26), v27_(v27), v28_(v28), v29_(v29), v30_(v30), + v31_(v31), v32_(v32), v33_(v33), v34_(v34), v35_(v35), v36_(v36), + v37_(v37), v38_(v38), v39_(v39), v40_(v40), v41_(v41), v42_(v42), + v43_(v43), v44_(v44) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_, v40_, v41_, v42_, v43_, v44_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray44& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; + const T40 v40_; + const T41 v41_; + const T42 v42_; + const T43 v43_; + const T44 v44_; +}; + +template +class ValueArray45 { + public: + ValueArray45(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42, T43 v43, T44 v44, T45 v45) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), + v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), + v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), + v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23), + v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), v29_(v29), + v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34), v35_(v35), + v36_(v36), v37_(v37), v38_(v38), v39_(v39), v40_(v40), v41_(v41), + v42_(v42), v43_(v43), v44_(v44), v45_(v45) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_, v40_, v41_, v42_, v43_, v44_, v45_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray45& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; + const T40 v40_; + const T41 v41_; + const T42 v42_; + const T43 v43_; + const T44 v44_; + const T45 v45_; +}; + +template +class ValueArray46 { + public: + ValueArray46(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42, T43 v43, T44 v44, T45 v45, T46 v46) : v1_(v1), v2_(v2), v3_(v3), + v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), + v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), + v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), + v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), + v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34), + v35_(v35), v36_(v36), v37_(v37), v38_(v38), v39_(v39), v40_(v40), + v41_(v41), v42_(v42), v43_(v43), v44_(v44), v45_(v45), v46_(v46) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_, v40_, v41_, v42_, v43_, v44_, v45_, v46_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray46& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; + const T40 v40_; + const T41 v41_; + const T42 v42_; + const T43 v43_; + const T44 v44_; + const T45 v45_; + const T46 v46_; +}; + +template +class ValueArray47 { + public: + ValueArray47(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47) : v1_(v1), v2_(v2), + v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), + v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), + v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), + v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), + v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34), + v35_(v35), v36_(v36), v37_(v37), v38_(v38), v39_(v39), v40_(v40), + v41_(v41), v42_(v42), v43_(v43), v44_(v44), v45_(v45), v46_(v46), + v47_(v47) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_, v40_, v41_, v42_, v43_, v44_, v45_, v46_, + v47_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray47& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; + const T40 v40_; + const T41 v41_; + const T42 v42_; + const T43 v43_; + const T44 v44_; + const T45 v45_; + const T46 v46_; + const T47 v47_; +}; + +template +class ValueArray48 { + public: + ValueArray48(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47, T48 v48) : v1_(v1), + v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), + v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), + v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), + v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), + v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33), + v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38), v39_(v39), + v40_(v40), v41_(v41), v42_(v42), v43_(v43), v44_(v44), v45_(v45), + v46_(v46), v47_(v47), v48_(v48) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_, v40_, v41_, v42_, v43_, v44_, v45_, v46_, v47_, + v48_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray48& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; + const T40 v40_; + const T41 v41_; + const T42 v42_; + const T43 v43_; + const T44 v44_; + const T45 v45_; + const T46 v46_; + const T47 v47_; + const T48 v48_; +}; + +template +class ValueArray49 { + public: + ValueArray49(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47, T48 v48, + T49 v49) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), + v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), + v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), + v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32), + v33_(v33), v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38), + v39_(v39), v40_(v40), v41_(v41), v42_(v42), v43_(v43), v44_(v44), + v45_(v45), v46_(v46), v47_(v47), v48_(v48), v49_(v49) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_, v40_, v41_, v42_, v43_, v44_, v45_, v46_, v47_, + v48_, v49_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray49& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; + const T40 v40_; + const T41 v41_; + const T42 v42_; + const T43 v43_; + const T44 v44_; + const T45 v45_; + const T46 v46_; + const T47 v47_; + const T48 v48_; + const T49 v49_; +}; + +template +class ValueArray50 { + public: + ValueArray50(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, + T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, + T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, + T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, + T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41, + T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47, T48 v48, T49 v49, + T50 v50) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), + v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), + v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), + v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), + v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32), + v33_(v33), v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38), + v39_(v39), v40_(v40), v41_(v41), v42_(v42), v43_(v43), v44_(v44), + v45_(v45), v46_(v46), v47_(v47), v48_(v48), v49_(v49), v50_(v50) {} + + template + operator ParamGenerator() const { + const T array[] = {v1_, v2_, v3_, v4_, v5_, v6_, v7_, v8_, v9_, v10_, v11_, + v12_, v13_, v14_, v15_, v16_, v17_, v18_, v19_, v20_, v21_, v22_, v23_, + v24_, v25_, v26_, v27_, v28_, v29_, v30_, v31_, v32_, v33_, v34_, v35_, + v36_, v37_, v38_, v39_, v40_, v41_, v42_, v43_, v44_, v45_, v46_, v47_, + v48_, v49_, v50_}; + return ValuesIn(array); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const ValueArray50& other); + + const T1 v1_; + const T2 v2_; + const T3 v3_; + const T4 v4_; + const T5 v5_; + const T6 v6_; + const T7 v7_; + const T8 v8_; + const T9 v9_; + const T10 v10_; + const T11 v11_; + const T12 v12_; + const T13 v13_; + const T14 v14_; + const T15 v15_; + const T16 v16_; + const T17 v17_; + const T18 v18_; + const T19 v19_; + const T20 v20_; + const T21 v21_; + const T22 v22_; + const T23 v23_; + const T24 v24_; + const T25 v25_; + const T26 v26_; + const T27 v27_; + const T28 v28_; + const T29 v29_; + const T30 v30_; + const T31 v31_; + const T32 v32_; + const T33 v33_; + const T34 v34_; + const T35 v35_; + const T36 v36_; + const T37 v37_; + const T38 v38_; + const T39 v39_; + const T40 v40_; + const T41 v41_; + const T42 v42_; + const T43 v43_; + const T44 v44_; + const T45 v45_; + const T46 v46_; + const T47 v47_; + const T48 v48_; + const T49 v49_; + const T50 v50_; +}; + +# if GTEST_HAS_COMBINE +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// Generates values from the Cartesian product of values produced +// by the argument generators. +// +template +class CartesianProductGenerator2 + : public ParamGeneratorInterface< ::std::tr1::tuple > { + public: + typedef ::std::tr1::tuple ParamType; + + CartesianProductGenerator2(const ParamGenerator& g1, + const ParamGenerator& g2) + : g1_(g1), g2_(g2) {} + virtual ~CartesianProductGenerator2() {} + + virtual ParamIteratorInterface* Begin() const { + return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin()); + } + virtual ParamIteratorInterface* End() const { + return new Iterator(this, g1_, g1_.end(), g2_, g2_.end()); + } + + private: + class Iterator : public ParamIteratorInterface { + public: + Iterator(const ParamGeneratorInterface* base, + const ParamGenerator& g1, + const typename ParamGenerator::iterator& current1, + const ParamGenerator& g2, + const typename ParamGenerator::iterator& current2) + : base_(base), + begin1_(g1.begin()), end1_(g1.end()), current1_(current1), + begin2_(g2.begin()), end2_(g2.end()), current2_(current2) { + ComputeCurrentValue(); + } + virtual ~Iterator() {} + + virtual const ParamGeneratorInterface* BaseGenerator() const { + return base_; + } + // Advance should not be called on beyond-of-range iterators + // so no component iterators must be beyond end of range, either. + virtual void Advance() { + assert(!AtEnd()); + ++current2_; + if (current2_ == end2_) { + current2_ = begin2_; + ++current1_; + } + ComputeCurrentValue(); + } + virtual ParamIteratorInterface* Clone() const { + return new Iterator(*this); + } + virtual const ParamType* Current() const { return ¤t_value_; } + virtual bool Equals(const ParamIteratorInterface& other) const { + // Having the same base generator guarantees that the other + // iterator is of the same type and we can downcast. + GTEST_CHECK_(BaseGenerator() == other.BaseGenerator()) + << "The program attempted to compare iterators " + << "from different generators." << std::endl; + const Iterator* typed_other = + CheckedDowncastToActualType(&other); + // We must report iterators equal if they both point beyond their + // respective ranges. That can happen in a variety of fashions, + // so we have to consult AtEnd(). + return (AtEnd() && typed_other->AtEnd()) || + ( + current1_ == typed_other->current1_ && + current2_ == typed_other->current2_); + } + + private: + Iterator(const Iterator& other) + : base_(other.base_), + begin1_(other.begin1_), + end1_(other.end1_), + current1_(other.current1_), + begin2_(other.begin2_), + end2_(other.end2_), + current2_(other.current2_) { + ComputeCurrentValue(); + } + + void ComputeCurrentValue() { + if (!AtEnd()) + current_value_ = ParamType(*current1_, *current2_); + } + bool AtEnd() const { + // We must report iterator past the end of the range when either of the + // component iterators has reached the end of its range. + return + current1_ == end1_ || + current2_ == end2_; + } + + // No implementation - assignment is unsupported. + void operator=(const Iterator& other); + + const ParamGeneratorInterface* const base_; + // begin[i]_ and end[i]_ define the i-th range that Iterator traverses. + // current[i]_ is the actual traversing iterator. + const typename ParamGenerator::iterator begin1_; + const typename ParamGenerator::iterator end1_; + typename ParamGenerator::iterator current1_; + const typename ParamGenerator::iterator begin2_; + const typename ParamGenerator::iterator end2_; + typename ParamGenerator::iterator current2_; + ParamType current_value_; + }; // class CartesianProductGenerator2::Iterator + + // No implementation - assignment is unsupported. + void operator=(const CartesianProductGenerator2& other); + + const ParamGenerator g1_; + const ParamGenerator g2_; +}; // class CartesianProductGenerator2 + + +template +class CartesianProductGenerator3 + : public ParamGeneratorInterface< ::std::tr1::tuple > { + public: + typedef ::std::tr1::tuple ParamType; + + CartesianProductGenerator3(const ParamGenerator& g1, + const ParamGenerator& g2, const ParamGenerator& g3) + : g1_(g1), g2_(g2), g3_(g3) {} + virtual ~CartesianProductGenerator3() {} + + virtual ParamIteratorInterface* Begin() const { + return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_, + g3_.begin()); + } + virtual ParamIteratorInterface* End() const { + return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end()); + } + + private: + class Iterator : public ParamIteratorInterface { + public: + Iterator(const ParamGeneratorInterface* base, + const ParamGenerator& g1, + const typename ParamGenerator::iterator& current1, + const ParamGenerator& g2, + const typename ParamGenerator::iterator& current2, + const ParamGenerator& g3, + const typename ParamGenerator::iterator& current3) + : base_(base), + begin1_(g1.begin()), end1_(g1.end()), current1_(current1), + begin2_(g2.begin()), end2_(g2.end()), current2_(current2), + begin3_(g3.begin()), end3_(g3.end()), current3_(current3) { + ComputeCurrentValue(); + } + virtual ~Iterator() {} + + virtual const ParamGeneratorInterface* BaseGenerator() const { + return base_; + } + // Advance should not be called on beyond-of-range iterators + // so no component iterators must be beyond end of range, either. + virtual void Advance() { + assert(!AtEnd()); + ++current3_; + if (current3_ == end3_) { + current3_ = begin3_; + ++current2_; + } + if (current2_ == end2_) { + current2_ = begin2_; + ++current1_; + } + ComputeCurrentValue(); + } + virtual ParamIteratorInterface* Clone() const { + return new Iterator(*this); + } + virtual const ParamType* Current() const { return ¤t_value_; } + virtual bool Equals(const ParamIteratorInterface& other) const { + // Having the same base generator guarantees that the other + // iterator is of the same type and we can downcast. + GTEST_CHECK_(BaseGenerator() == other.BaseGenerator()) + << "The program attempted to compare iterators " + << "from different generators." << std::endl; + const Iterator* typed_other = + CheckedDowncastToActualType(&other); + // We must report iterators equal if they both point beyond their + // respective ranges. That can happen in a variety of fashions, + // so we have to consult AtEnd(). + return (AtEnd() && typed_other->AtEnd()) || + ( + current1_ == typed_other->current1_ && + current2_ == typed_other->current2_ && + current3_ == typed_other->current3_); + } + + private: + Iterator(const Iterator& other) + : base_(other.base_), + begin1_(other.begin1_), + end1_(other.end1_), + current1_(other.current1_), + begin2_(other.begin2_), + end2_(other.end2_), + current2_(other.current2_), + begin3_(other.begin3_), + end3_(other.end3_), + current3_(other.current3_) { + ComputeCurrentValue(); + } + + void ComputeCurrentValue() { + if (!AtEnd()) + current_value_ = ParamType(*current1_, *current2_, *current3_); + } + bool AtEnd() const { + // We must report iterator past the end of the range when either of the + // component iterators has reached the end of its range. + return + current1_ == end1_ || + current2_ == end2_ || + current3_ == end3_; + } + + // No implementation - assignment is unsupported. + void operator=(const Iterator& other); + + const ParamGeneratorInterface* const base_; + // begin[i]_ and end[i]_ define the i-th range that Iterator traverses. + // current[i]_ is the actual traversing iterator. + const typename ParamGenerator::iterator begin1_; + const typename ParamGenerator::iterator end1_; + typename ParamGenerator::iterator current1_; + const typename ParamGenerator::iterator begin2_; + const typename ParamGenerator::iterator end2_; + typename ParamGenerator::iterator current2_; + const typename ParamGenerator::iterator begin3_; + const typename ParamGenerator::iterator end3_; + typename ParamGenerator::iterator current3_; + ParamType current_value_; + }; // class CartesianProductGenerator3::Iterator + + // No implementation - assignment is unsupported. + void operator=(const CartesianProductGenerator3& other); + + const ParamGenerator g1_; + const ParamGenerator g2_; + const ParamGenerator g3_; +}; // class CartesianProductGenerator3 + + +template +class CartesianProductGenerator4 + : public ParamGeneratorInterface< ::std::tr1::tuple > { + public: + typedef ::std::tr1::tuple ParamType; + + CartesianProductGenerator4(const ParamGenerator& g1, + const ParamGenerator& g2, const ParamGenerator& g3, + const ParamGenerator& g4) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4) {} + virtual ~CartesianProductGenerator4() {} + + virtual ParamIteratorInterface* Begin() const { + return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_, + g3_.begin(), g4_, g4_.begin()); + } + virtual ParamIteratorInterface* End() const { + return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(), + g4_, g4_.end()); + } + + private: + class Iterator : public ParamIteratorInterface { + public: + Iterator(const ParamGeneratorInterface* base, + const ParamGenerator& g1, + const typename ParamGenerator::iterator& current1, + const ParamGenerator& g2, + const typename ParamGenerator::iterator& current2, + const ParamGenerator& g3, + const typename ParamGenerator::iterator& current3, + const ParamGenerator& g4, + const typename ParamGenerator::iterator& current4) + : base_(base), + begin1_(g1.begin()), end1_(g1.end()), current1_(current1), + begin2_(g2.begin()), end2_(g2.end()), current2_(current2), + begin3_(g3.begin()), end3_(g3.end()), current3_(current3), + begin4_(g4.begin()), end4_(g4.end()), current4_(current4) { + ComputeCurrentValue(); + } + virtual ~Iterator() {} + + virtual const ParamGeneratorInterface* BaseGenerator() const { + return base_; + } + // Advance should not be called on beyond-of-range iterators + // so no component iterators must be beyond end of range, either. + virtual void Advance() { + assert(!AtEnd()); + ++current4_; + if (current4_ == end4_) { + current4_ = begin4_; + ++current3_; + } + if (current3_ == end3_) { + current3_ = begin3_; + ++current2_; + } + if (current2_ == end2_) { + current2_ = begin2_; + ++current1_; + } + ComputeCurrentValue(); + } + virtual ParamIteratorInterface* Clone() const { + return new Iterator(*this); + } + virtual const ParamType* Current() const { return ¤t_value_; } + virtual bool Equals(const ParamIteratorInterface& other) const { + // Having the same base generator guarantees that the other + // iterator is of the same type and we can downcast. + GTEST_CHECK_(BaseGenerator() == other.BaseGenerator()) + << "The program attempted to compare iterators " + << "from different generators." << std::endl; + const Iterator* typed_other = + CheckedDowncastToActualType(&other); + // We must report iterators equal if they both point beyond their + // respective ranges. That can happen in a variety of fashions, + // so we have to consult AtEnd(). + return (AtEnd() && typed_other->AtEnd()) || + ( + current1_ == typed_other->current1_ && + current2_ == typed_other->current2_ && + current3_ == typed_other->current3_ && + current4_ == typed_other->current4_); + } + + private: + Iterator(const Iterator& other) + : base_(other.base_), + begin1_(other.begin1_), + end1_(other.end1_), + current1_(other.current1_), + begin2_(other.begin2_), + end2_(other.end2_), + current2_(other.current2_), + begin3_(other.begin3_), + end3_(other.end3_), + current3_(other.current3_), + begin4_(other.begin4_), + end4_(other.end4_), + current4_(other.current4_) { + ComputeCurrentValue(); + } + + void ComputeCurrentValue() { + if (!AtEnd()) + current_value_ = ParamType(*current1_, *current2_, *current3_, + *current4_); + } + bool AtEnd() const { + // We must report iterator past the end of the range when either of the + // component iterators has reached the end of its range. + return + current1_ == end1_ || + current2_ == end2_ || + current3_ == end3_ || + current4_ == end4_; + } + + // No implementation - assignment is unsupported. + void operator=(const Iterator& other); + + const ParamGeneratorInterface* const base_; + // begin[i]_ and end[i]_ define the i-th range that Iterator traverses. + // current[i]_ is the actual traversing iterator. + const typename ParamGenerator::iterator begin1_; + const typename ParamGenerator::iterator end1_; + typename ParamGenerator::iterator current1_; + const typename ParamGenerator::iterator begin2_; + const typename ParamGenerator::iterator end2_; + typename ParamGenerator::iterator current2_; + const typename ParamGenerator::iterator begin3_; + const typename ParamGenerator::iterator end3_; + typename ParamGenerator::iterator current3_; + const typename ParamGenerator::iterator begin4_; + const typename ParamGenerator::iterator end4_; + typename ParamGenerator::iterator current4_; + ParamType current_value_; + }; // class CartesianProductGenerator4::Iterator + + // No implementation - assignment is unsupported. + void operator=(const CartesianProductGenerator4& other); + + const ParamGenerator g1_; + const ParamGenerator g2_; + const ParamGenerator g3_; + const ParamGenerator g4_; +}; // class CartesianProductGenerator4 + + +template +class CartesianProductGenerator5 + : public ParamGeneratorInterface< ::std::tr1::tuple > { + public: + typedef ::std::tr1::tuple ParamType; + + CartesianProductGenerator5(const ParamGenerator& g1, + const ParamGenerator& g2, const ParamGenerator& g3, + const ParamGenerator& g4, const ParamGenerator& g5) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5) {} + virtual ~CartesianProductGenerator5() {} + + virtual ParamIteratorInterface* Begin() const { + return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_, + g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin()); + } + virtual ParamIteratorInterface* End() const { + return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(), + g4_, g4_.end(), g5_, g5_.end()); + } + + private: + class Iterator : public ParamIteratorInterface { + public: + Iterator(const ParamGeneratorInterface* base, + const ParamGenerator& g1, + const typename ParamGenerator::iterator& current1, + const ParamGenerator& g2, + const typename ParamGenerator::iterator& current2, + const ParamGenerator& g3, + const typename ParamGenerator::iterator& current3, + const ParamGenerator& g4, + const typename ParamGenerator::iterator& current4, + const ParamGenerator& g5, + const typename ParamGenerator::iterator& current5) + : base_(base), + begin1_(g1.begin()), end1_(g1.end()), current1_(current1), + begin2_(g2.begin()), end2_(g2.end()), current2_(current2), + begin3_(g3.begin()), end3_(g3.end()), current3_(current3), + begin4_(g4.begin()), end4_(g4.end()), current4_(current4), + begin5_(g5.begin()), end5_(g5.end()), current5_(current5) { + ComputeCurrentValue(); + } + virtual ~Iterator() {} + + virtual const ParamGeneratorInterface* BaseGenerator() const { + return base_; + } + // Advance should not be called on beyond-of-range iterators + // so no component iterators must be beyond end of range, either. + virtual void Advance() { + assert(!AtEnd()); + ++current5_; + if (current5_ == end5_) { + current5_ = begin5_; + ++current4_; + } + if (current4_ == end4_) { + current4_ = begin4_; + ++current3_; + } + if (current3_ == end3_) { + current3_ = begin3_; + ++current2_; + } + if (current2_ == end2_) { + current2_ = begin2_; + ++current1_; + } + ComputeCurrentValue(); + } + virtual ParamIteratorInterface* Clone() const { + return new Iterator(*this); + } + virtual const ParamType* Current() const { return ¤t_value_; } + virtual bool Equals(const ParamIteratorInterface& other) const { + // Having the same base generator guarantees that the other + // iterator is of the same type and we can downcast. + GTEST_CHECK_(BaseGenerator() == other.BaseGenerator()) + << "The program attempted to compare iterators " + << "from different generators." << std::endl; + const Iterator* typed_other = + CheckedDowncastToActualType(&other); + // We must report iterators equal if they both point beyond their + // respective ranges. That can happen in a variety of fashions, + // so we have to consult AtEnd(). + return (AtEnd() && typed_other->AtEnd()) || + ( + current1_ == typed_other->current1_ && + current2_ == typed_other->current2_ && + current3_ == typed_other->current3_ && + current4_ == typed_other->current4_ && + current5_ == typed_other->current5_); + } + + private: + Iterator(const Iterator& other) + : base_(other.base_), + begin1_(other.begin1_), + end1_(other.end1_), + current1_(other.current1_), + begin2_(other.begin2_), + end2_(other.end2_), + current2_(other.current2_), + begin3_(other.begin3_), + end3_(other.end3_), + current3_(other.current3_), + begin4_(other.begin4_), + end4_(other.end4_), + current4_(other.current4_), + begin5_(other.begin5_), + end5_(other.end5_), + current5_(other.current5_) { + ComputeCurrentValue(); + } + + void ComputeCurrentValue() { + if (!AtEnd()) + current_value_ = ParamType(*current1_, *current2_, *current3_, + *current4_, *current5_); + } + bool AtEnd() const { + // We must report iterator past the end of the range when either of the + // component iterators has reached the end of its range. + return + current1_ == end1_ || + current2_ == end2_ || + current3_ == end3_ || + current4_ == end4_ || + current5_ == end5_; + } + + // No implementation - assignment is unsupported. + void operator=(const Iterator& other); + + const ParamGeneratorInterface* const base_; + // begin[i]_ and end[i]_ define the i-th range that Iterator traverses. + // current[i]_ is the actual traversing iterator. + const typename ParamGenerator::iterator begin1_; + const typename ParamGenerator::iterator end1_; + typename ParamGenerator::iterator current1_; + const typename ParamGenerator::iterator begin2_; + const typename ParamGenerator::iterator end2_; + typename ParamGenerator::iterator current2_; + const typename ParamGenerator::iterator begin3_; + const typename ParamGenerator::iterator end3_; + typename ParamGenerator::iterator current3_; + const typename ParamGenerator::iterator begin4_; + const typename ParamGenerator::iterator end4_; + typename ParamGenerator::iterator current4_; + const typename ParamGenerator::iterator begin5_; + const typename ParamGenerator::iterator end5_; + typename ParamGenerator::iterator current5_; + ParamType current_value_; + }; // class CartesianProductGenerator5::Iterator + + // No implementation - assignment is unsupported. + void operator=(const CartesianProductGenerator5& other); + + const ParamGenerator g1_; + const ParamGenerator g2_; + const ParamGenerator g3_; + const ParamGenerator g4_; + const ParamGenerator g5_; +}; // class CartesianProductGenerator5 + + +template +class CartesianProductGenerator6 + : public ParamGeneratorInterface< ::std::tr1::tuple > { + public: + typedef ::std::tr1::tuple ParamType; + + CartesianProductGenerator6(const ParamGenerator& g1, + const ParamGenerator& g2, const ParamGenerator& g3, + const ParamGenerator& g4, const ParamGenerator& g5, + const ParamGenerator& g6) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6) {} + virtual ~CartesianProductGenerator6() {} + + virtual ParamIteratorInterface* Begin() const { + return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_, + g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin(), g6_, g6_.begin()); + } + virtual ParamIteratorInterface* End() const { + return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(), + g4_, g4_.end(), g5_, g5_.end(), g6_, g6_.end()); + } + + private: + class Iterator : public ParamIteratorInterface { + public: + Iterator(const ParamGeneratorInterface* base, + const ParamGenerator& g1, + const typename ParamGenerator::iterator& current1, + const ParamGenerator& g2, + const typename ParamGenerator::iterator& current2, + const ParamGenerator& g3, + const typename ParamGenerator::iterator& current3, + const ParamGenerator& g4, + const typename ParamGenerator::iterator& current4, + const ParamGenerator& g5, + const typename ParamGenerator::iterator& current5, + const ParamGenerator& g6, + const typename ParamGenerator::iterator& current6) + : base_(base), + begin1_(g1.begin()), end1_(g1.end()), current1_(current1), + begin2_(g2.begin()), end2_(g2.end()), current2_(current2), + begin3_(g3.begin()), end3_(g3.end()), current3_(current3), + begin4_(g4.begin()), end4_(g4.end()), current4_(current4), + begin5_(g5.begin()), end5_(g5.end()), current5_(current5), + begin6_(g6.begin()), end6_(g6.end()), current6_(current6) { + ComputeCurrentValue(); + } + virtual ~Iterator() {} + + virtual const ParamGeneratorInterface* BaseGenerator() const { + return base_; + } + // Advance should not be called on beyond-of-range iterators + // so no component iterators must be beyond end of range, either. + virtual void Advance() { + assert(!AtEnd()); + ++current6_; + if (current6_ == end6_) { + current6_ = begin6_; + ++current5_; + } + if (current5_ == end5_) { + current5_ = begin5_; + ++current4_; + } + if (current4_ == end4_) { + current4_ = begin4_; + ++current3_; + } + if (current3_ == end3_) { + current3_ = begin3_; + ++current2_; + } + if (current2_ == end2_) { + current2_ = begin2_; + ++current1_; + } + ComputeCurrentValue(); + } + virtual ParamIteratorInterface* Clone() const { + return new Iterator(*this); + } + virtual const ParamType* Current() const { return ¤t_value_; } + virtual bool Equals(const ParamIteratorInterface& other) const { + // Having the same base generator guarantees that the other + // iterator is of the same type and we can downcast. + GTEST_CHECK_(BaseGenerator() == other.BaseGenerator()) + << "The program attempted to compare iterators " + << "from different generators." << std::endl; + const Iterator* typed_other = + CheckedDowncastToActualType(&other); + // We must report iterators equal if they both point beyond their + // respective ranges. That can happen in a variety of fashions, + // so we have to consult AtEnd(). + return (AtEnd() && typed_other->AtEnd()) || + ( + current1_ == typed_other->current1_ && + current2_ == typed_other->current2_ && + current3_ == typed_other->current3_ && + current4_ == typed_other->current4_ && + current5_ == typed_other->current5_ && + current6_ == typed_other->current6_); + } + + private: + Iterator(const Iterator& other) + : base_(other.base_), + begin1_(other.begin1_), + end1_(other.end1_), + current1_(other.current1_), + begin2_(other.begin2_), + end2_(other.end2_), + current2_(other.current2_), + begin3_(other.begin3_), + end3_(other.end3_), + current3_(other.current3_), + begin4_(other.begin4_), + end4_(other.end4_), + current4_(other.current4_), + begin5_(other.begin5_), + end5_(other.end5_), + current5_(other.current5_), + begin6_(other.begin6_), + end6_(other.end6_), + current6_(other.current6_) { + ComputeCurrentValue(); + } + + void ComputeCurrentValue() { + if (!AtEnd()) + current_value_ = ParamType(*current1_, *current2_, *current3_, + *current4_, *current5_, *current6_); + } + bool AtEnd() const { + // We must report iterator past the end of the range when either of the + // component iterators has reached the end of its range. + return + current1_ == end1_ || + current2_ == end2_ || + current3_ == end3_ || + current4_ == end4_ || + current5_ == end5_ || + current6_ == end6_; + } + + // No implementation - assignment is unsupported. + void operator=(const Iterator& other); + + const ParamGeneratorInterface* const base_; + // begin[i]_ and end[i]_ define the i-th range that Iterator traverses. + // current[i]_ is the actual traversing iterator. + const typename ParamGenerator::iterator begin1_; + const typename ParamGenerator::iterator end1_; + typename ParamGenerator::iterator current1_; + const typename ParamGenerator::iterator begin2_; + const typename ParamGenerator::iterator end2_; + typename ParamGenerator::iterator current2_; + const typename ParamGenerator::iterator begin3_; + const typename ParamGenerator::iterator end3_; + typename ParamGenerator::iterator current3_; + const typename ParamGenerator::iterator begin4_; + const typename ParamGenerator::iterator end4_; + typename ParamGenerator::iterator current4_; + const typename ParamGenerator::iterator begin5_; + const typename ParamGenerator::iterator end5_; + typename ParamGenerator::iterator current5_; + const typename ParamGenerator::iterator begin6_; + const typename ParamGenerator::iterator end6_; + typename ParamGenerator::iterator current6_; + ParamType current_value_; + }; // class CartesianProductGenerator6::Iterator + + // No implementation - assignment is unsupported. + void operator=(const CartesianProductGenerator6& other); + + const ParamGenerator g1_; + const ParamGenerator g2_; + const ParamGenerator g3_; + const ParamGenerator g4_; + const ParamGenerator g5_; + const ParamGenerator g6_; +}; // class CartesianProductGenerator6 + + +template +class CartesianProductGenerator7 + : public ParamGeneratorInterface< ::std::tr1::tuple > { + public: + typedef ::std::tr1::tuple ParamType; + + CartesianProductGenerator7(const ParamGenerator& g1, + const ParamGenerator& g2, const ParamGenerator& g3, + const ParamGenerator& g4, const ParamGenerator& g5, + const ParamGenerator& g6, const ParamGenerator& g7) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7) {} + virtual ~CartesianProductGenerator7() {} + + virtual ParamIteratorInterface* Begin() const { + return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_, + g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin(), g6_, g6_.begin(), g7_, + g7_.begin()); + } + virtual ParamIteratorInterface* End() const { + return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(), + g4_, g4_.end(), g5_, g5_.end(), g6_, g6_.end(), g7_, g7_.end()); + } + + private: + class Iterator : public ParamIteratorInterface { + public: + Iterator(const ParamGeneratorInterface* base, + const ParamGenerator& g1, + const typename ParamGenerator::iterator& current1, + const ParamGenerator& g2, + const typename ParamGenerator::iterator& current2, + const ParamGenerator& g3, + const typename ParamGenerator::iterator& current3, + const ParamGenerator& g4, + const typename ParamGenerator::iterator& current4, + const ParamGenerator& g5, + const typename ParamGenerator::iterator& current5, + const ParamGenerator& g6, + const typename ParamGenerator::iterator& current6, + const ParamGenerator& g7, + const typename ParamGenerator::iterator& current7) + : base_(base), + begin1_(g1.begin()), end1_(g1.end()), current1_(current1), + begin2_(g2.begin()), end2_(g2.end()), current2_(current2), + begin3_(g3.begin()), end3_(g3.end()), current3_(current3), + begin4_(g4.begin()), end4_(g4.end()), current4_(current4), + begin5_(g5.begin()), end5_(g5.end()), current5_(current5), + begin6_(g6.begin()), end6_(g6.end()), current6_(current6), + begin7_(g7.begin()), end7_(g7.end()), current7_(current7) { + ComputeCurrentValue(); + } + virtual ~Iterator() {} + + virtual const ParamGeneratorInterface* BaseGenerator() const { + return base_; + } + // Advance should not be called on beyond-of-range iterators + // so no component iterators must be beyond end of range, either. + virtual void Advance() { + assert(!AtEnd()); + ++current7_; + if (current7_ == end7_) { + current7_ = begin7_; + ++current6_; + } + if (current6_ == end6_) { + current6_ = begin6_; + ++current5_; + } + if (current5_ == end5_) { + current5_ = begin5_; + ++current4_; + } + if (current4_ == end4_) { + current4_ = begin4_; + ++current3_; + } + if (current3_ == end3_) { + current3_ = begin3_; + ++current2_; + } + if (current2_ == end2_) { + current2_ = begin2_; + ++current1_; + } + ComputeCurrentValue(); + } + virtual ParamIteratorInterface* Clone() const { + return new Iterator(*this); + } + virtual const ParamType* Current() const { return ¤t_value_; } + virtual bool Equals(const ParamIteratorInterface& other) const { + // Having the same base generator guarantees that the other + // iterator is of the same type and we can downcast. + GTEST_CHECK_(BaseGenerator() == other.BaseGenerator()) + << "The program attempted to compare iterators " + << "from different generators." << std::endl; + const Iterator* typed_other = + CheckedDowncastToActualType(&other); + // We must report iterators equal if they both point beyond their + // respective ranges. That can happen in a variety of fashions, + // so we have to consult AtEnd(). + return (AtEnd() && typed_other->AtEnd()) || + ( + current1_ == typed_other->current1_ && + current2_ == typed_other->current2_ && + current3_ == typed_other->current3_ && + current4_ == typed_other->current4_ && + current5_ == typed_other->current5_ && + current6_ == typed_other->current6_ && + current7_ == typed_other->current7_); + } + + private: + Iterator(const Iterator& other) + : base_(other.base_), + begin1_(other.begin1_), + end1_(other.end1_), + current1_(other.current1_), + begin2_(other.begin2_), + end2_(other.end2_), + current2_(other.current2_), + begin3_(other.begin3_), + end3_(other.end3_), + current3_(other.current3_), + begin4_(other.begin4_), + end4_(other.end4_), + current4_(other.current4_), + begin5_(other.begin5_), + end5_(other.end5_), + current5_(other.current5_), + begin6_(other.begin6_), + end6_(other.end6_), + current6_(other.current6_), + begin7_(other.begin7_), + end7_(other.end7_), + current7_(other.current7_) { + ComputeCurrentValue(); + } + + void ComputeCurrentValue() { + if (!AtEnd()) + current_value_ = ParamType(*current1_, *current2_, *current3_, + *current4_, *current5_, *current6_, *current7_); + } + bool AtEnd() const { + // We must report iterator past the end of the range when either of the + // component iterators has reached the end of its range. + return + current1_ == end1_ || + current2_ == end2_ || + current3_ == end3_ || + current4_ == end4_ || + current5_ == end5_ || + current6_ == end6_ || + current7_ == end7_; + } + + // No implementation - assignment is unsupported. + void operator=(const Iterator& other); + + const ParamGeneratorInterface* const base_; + // begin[i]_ and end[i]_ define the i-th range that Iterator traverses. + // current[i]_ is the actual traversing iterator. + const typename ParamGenerator::iterator begin1_; + const typename ParamGenerator::iterator end1_; + typename ParamGenerator::iterator current1_; + const typename ParamGenerator::iterator begin2_; + const typename ParamGenerator::iterator end2_; + typename ParamGenerator::iterator current2_; + const typename ParamGenerator::iterator begin3_; + const typename ParamGenerator::iterator end3_; + typename ParamGenerator::iterator current3_; + const typename ParamGenerator::iterator begin4_; + const typename ParamGenerator::iterator end4_; + typename ParamGenerator::iterator current4_; + const typename ParamGenerator::iterator begin5_; + const typename ParamGenerator::iterator end5_; + typename ParamGenerator::iterator current5_; + const typename ParamGenerator::iterator begin6_; + const typename ParamGenerator::iterator end6_; + typename ParamGenerator::iterator current6_; + const typename ParamGenerator::iterator begin7_; + const typename ParamGenerator::iterator end7_; + typename ParamGenerator::iterator current7_; + ParamType current_value_; + }; // class CartesianProductGenerator7::Iterator + + // No implementation - assignment is unsupported. + void operator=(const CartesianProductGenerator7& other); + + const ParamGenerator g1_; + const ParamGenerator g2_; + const ParamGenerator g3_; + const ParamGenerator g4_; + const ParamGenerator g5_; + const ParamGenerator g6_; + const ParamGenerator g7_; +}; // class CartesianProductGenerator7 + + +template +class CartesianProductGenerator8 + : public ParamGeneratorInterface< ::std::tr1::tuple > { + public: + typedef ::std::tr1::tuple ParamType; + + CartesianProductGenerator8(const ParamGenerator& g1, + const ParamGenerator& g2, const ParamGenerator& g3, + const ParamGenerator& g4, const ParamGenerator& g5, + const ParamGenerator& g6, const ParamGenerator& g7, + const ParamGenerator& g8) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7), + g8_(g8) {} + virtual ~CartesianProductGenerator8() {} + + virtual ParamIteratorInterface* Begin() const { + return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_, + g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin(), g6_, g6_.begin(), g7_, + g7_.begin(), g8_, g8_.begin()); + } + virtual ParamIteratorInterface* End() const { + return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(), + g4_, g4_.end(), g5_, g5_.end(), g6_, g6_.end(), g7_, g7_.end(), g8_, + g8_.end()); + } + + private: + class Iterator : public ParamIteratorInterface { + public: + Iterator(const ParamGeneratorInterface* base, + const ParamGenerator& g1, + const typename ParamGenerator::iterator& current1, + const ParamGenerator& g2, + const typename ParamGenerator::iterator& current2, + const ParamGenerator& g3, + const typename ParamGenerator::iterator& current3, + const ParamGenerator& g4, + const typename ParamGenerator::iterator& current4, + const ParamGenerator& g5, + const typename ParamGenerator::iterator& current5, + const ParamGenerator& g6, + const typename ParamGenerator::iterator& current6, + const ParamGenerator& g7, + const typename ParamGenerator::iterator& current7, + const ParamGenerator& g8, + const typename ParamGenerator::iterator& current8) + : base_(base), + begin1_(g1.begin()), end1_(g1.end()), current1_(current1), + begin2_(g2.begin()), end2_(g2.end()), current2_(current2), + begin3_(g3.begin()), end3_(g3.end()), current3_(current3), + begin4_(g4.begin()), end4_(g4.end()), current4_(current4), + begin5_(g5.begin()), end5_(g5.end()), current5_(current5), + begin6_(g6.begin()), end6_(g6.end()), current6_(current6), + begin7_(g7.begin()), end7_(g7.end()), current7_(current7), + begin8_(g8.begin()), end8_(g8.end()), current8_(current8) { + ComputeCurrentValue(); + } + virtual ~Iterator() {} + + virtual const ParamGeneratorInterface* BaseGenerator() const { + return base_; + } + // Advance should not be called on beyond-of-range iterators + // so no component iterators must be beyond end of range, either. + virtual void Advance() { + assert(!AtEnd()); + ++current8_; + if (current8_ == end8_) { + current8_ = begin8_; + ++current7_; + } + if (current7_ == end7_) { + current7_ = begin7_; + ++current6_; + } + if (current6_ == end6_) { + current6_ = begin6_; + ++current5_; + } + if (current5_ == end5_) { + current5_ = begin5_; + ++current4_; + } + if (current4_ == end4_) { + current4_ = begin4_; + ++current3_; + } + if (current3_ == end3_) { + current3_ = begin3_; + ++current2_; + } + if (current2_ == end2_) { + current2_ = begin2_; + ++current1_; + } + ComputeCurrentValue(); + } + virtual ParamIteratorInterface* Clone() const { + return new Iterator(*this); + } + virtual const ParamType* Current() const { return ¤t_value_; } + virtual bool Equals(const ParamIteratorInterface& other) const { + // Having the same base generator guarantees that the other + // iterator is of the same type and we can downcast. + GTEST_CHECK_(BaseGenerator() == other.BaseGenerator()) + << "The program attempted to compare iterators " + << "from different generators." << std::endl; + const Iterator* typed_other = + CheckedDowncastToActualType(&other); + // We must report iterators equal if they both point beyond their + // respective ranges. That can happen in a variety of fashions, + // so we have to consult AtEnd(). + return (AtEnd() && typed_other->AtEnd()) || + ( + current1_ == typed_other->current1_ && + current2_ == typed_other->current2_ && + current3_ == typed_other->current3_ && + current4_ == typed_other->current4_ && + current5_ == typed_other->current5_ && + current6_ == typed_other->current6_ && + current7_ == typed_other->current7_ && + current8_ == typed_other->current8_); + } + + private: + Iterator(const Iterator& other) + : base_(other.base_), + begin1_(other.begin1_), + end1_(other.end1_), + current1_(other.current1_), + begin2_(other.begin2_), + end2_(other.end2_), + current2_(other.current2_), + begin3_(other.begin3_), + end3_(other.end3_), + current3_(other.current3_), + begin4_(other.begin4_), + end4_(other.end4_), + current4_(other.current4_), + begin5_(other.begin5_), + end5_(other.end5_), + current5_(other.current5_), + begin6_(other.begin6_), + end6_(other.end6_), + current6_(other.current6_), + begin7_(other.begin7_), + end7_(other.end7_), + current7_(other.current7_), + begin8_(other.begin8_), + end8_(other.end8_), + current8_(other.current8_) { + ComputeCurrentValue(); + } + + void ComputeCurrentValue() { + if (!AtEnd()) + current_value_ = ParamType(*current1_, *current2_, *current3_, + *current4_, *current5_, *current6_, *current7_, *current8_); + } + bool AtEnd() const { + // We must report iterator past the end of the range when either of the + // component iterators has reached the end of its range. + return + current1_ == end1_ || + current2_ == end2_ || + current3_ == end3_ || + current4_ == end4_ || + current5_ == end5_ || + current6_ == end6_ || + current7_ == end7_ || + current8_ == end8_; + } + + // No implementation - assignment is unsupported. + void operator=(const Iterator& other); + + const ParamGeneratorInterface* const base_; + // begin[i]_ and end[i]_ define the i-th range that Iterator traverses. + // current[i]_ is the actual traversing iterator. + const typename ParamGenerator::iterator begin1_; + const typename ParamGenerator::iterator end1_; + typename ParamGenerator::iterator current1_; + const typename ParamGenerator::iterator begin2_; + const typename ParamGenerator::iterator end2_; + typename ParamGenerator::iterator current2_; + const typename ParamGenerator::iterator begin3_; + const typename ParamGenerator::iterator end3_; + typename ParamGenerator::iterator current3_; + const typename ParamGenerator::iterator begin4_; + const typename ParamGenerator::iterator end4_; + typename ParamGenerator::iterator current4_; + const typename ParamGenerator::iterator begin5_; + const typename ParamGenerator::iterator end5_; + typename ParamGenerator::iterator current5_; + const typename ParamGenerator::iterator begin6_; + const typename ParamGenerator::iterator end6_; + typename ParamGenerator::iterator current6_; + const typename ParamGenerator::iterator begin7_; + const typename ParamGenerator::iterator end7_; + typename ParamGenerator::iterator current7_; + const typename ParamGenerator::iterator begin8_; + const typename ParamGenerator::iterator end8_; + typename ParamGenerator::iterator current8_; + ParamType current_value_; + }; // class CartesianProductGenerator8::Iterator + + // No implementation - assignment is unsupported. + void operator=(const CartesianProductGenerator8& other); + + const ParamGenerator g1_; + const ParamGenerator g2_; + const ParamGenerator g3_; + const ParamGenerator g4_; + const ParamGenerator g5_; + const ParamGenerator g6_; + const ParamGenerator g7_; + const ParamGenerator g8_; +}; // class CartesianProductGenerator8 + + +template +class CartesianProductGenerator9 + : public ParamGeneratorInterface< ::std::tr1::tuple > { + public: + typedef ::std::tr1::tuple ParamType; + + CartesianProductGenerator9(const ParamGenerator& g1, + const ParamGenerator& g2, const ParamGenerator& g3, + const ParamGenerator& g4, const ParamGenerator& g5, + const ParamGenerator& g6, const ParamGenerator& g7, + const ParamGenerator& g8, const ParamGenerator& g9) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7), g8_(g8), + g9_(g9) {} + virtual ~CartesianProductGenerator9() {} + + virtual ParamIteratorInterface* Begin() const { + return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_, + g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin(), g6_, g6_.begin(), g7_, + g7_.begin(), g8_, g8_.begin(), g9_, g9_.begin()); + } + virtual ParamIteratorInterface* End() const { + return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(), + g4_, g4_.end(), g5_, g5_.end(), g6_, g6_.end(), g7_, g7_.end(), g8_, + g8_.end(), g9_, g9_.end()); + } + + private: + class Iterator : public ParamIteratorInterface { + public: + Iterator(const ParamGeneratorInterface* base, + const ParamGenerator& g1, + const typename ParamGenerator::iterator& current1, + const ParamGenerator& g2, + const typename ParamGenerator::iterator& current2, + const ParamGenerator& g3, + const typename ParamGenerator::iterator& current3, + const ParamGenerator& g4, + const typename ParamGenerator::iterator& current4, + const ParamGenerator& g5, + const typename ParamGenerator::iterator& current5, + const ParamGenerator& g6, + const typename ParamGenerator::iterator& current6, + const ParamGenerator& g7, + const typename ParamGenerator::iterator& current7, + const ParamGenerator& g8, + const typename ParamGenerator::iterator& current8, + const ParamGenerator& g9, + const typename ParamGenerator::iterator& current9) + : base_(base), + begin1_(g1.begin()), end1_(g1.end()), current1_(current1), + begin2_(g2.begin()), end2_(g2.end()), current2_(current2), + begin3_(g3.begin()), end3_(g3.end()), current3_(current3), + begin4_(g4.begin()), end4_(g4.end()), current4_(current4), + begin5_(g5.begin()), end5_(g5.end()), current5_(current5), + begin6_(g6.begin()), end6_(g6.end()), current6_(current6), + begin7_(g7.begin()), end7_(g7.end()), current7_(current7), + begin8_(g8.begin()), end8_(g8.end()), current8_(current8), + begin9_(g9.begin()), end9_(g9.end()), current9_(current9) { + ComputeCurrentValue(); + } + virtual ~Iterator() {} + + virtual const ParamGeneratorInterface* BaseGenerator() const { + return base_; + } + // Advance should not be called on beyond-of-range iterators + // so no component iterators must be beyond end of range, either. + virtual void Advance() { + assert(!AtEnd()); + ++current9_; + if (current9_ == end9_) { + current9_ = begin9_; + ++current8_; + } + if (current8_ == end8_) { + current8_ = begin8_; + ++current7_; + } + if (current7_ == end7_) { + current7_ = begin7_; + ++current6_; + } + if (current6_ == end6_) { + current6_ = begin6_; + ++current5_; + } + if (current5_ == end5_) { + current5_ = begin5_; + ++current4_; + } + if (current4_ == end4_) { + current4_ = begin4_; + ++current3_; + } + if (current3_ == end3_) { + current3_ = begin3_; + ++current2_; + } + if (current2_ == end2_) { + current2_ = begin2_; + ++current1_; + } + ComputeCurrentValue(); + } + virtual ParamIteratorInterface* Clone() const { + return new Iterator(*this); + } + virtual const ParamType* Current() const { return ¤t_value_; } + virtual bool Equals(const ParamIteratorInterface& other) const { + // Having the same base generator guarantees that the other + // iterator is of the same type and we can downcast. + GTEST_CHECK_(BaseGenerator() == other.BaseGenerator()) + << "The program attempted to compare iterators " + << "from different generators." << std::endl; + const Iterator* typed_other = + CheckedDowncastToActualType(&other); + // We must report iterators equal if they both point beyond their + // respective ranges. That can happen in a variety of fashions, + // so we have to consult AtEnd(). + return (AtEnd() && typed_other->AtEnd()) || + ( + current1_ == typed_other->current1_ && + current2_ == typed_other->current2_ && + current3_ == typed_other->current3_ && + current4_ == typed_other->current4_ && + current5_ == typed_other->current5_ && + current6_ == typed_other->current6_ && + current7_ == typed_other->current7_ && + current8_ == typed_other->current8_ && + current9_ == typed_other->current9_); + } + + private: + Iterator(const Iterator& other) + : base_(other.base_), + begin1_(other.begin1_), + end1_(other.end1_), + current1_(other.current1_), + begin2_(other.begin2_), + end2_(other.end2_), + current2_(other.current2_), + begin3_(other.begin3_), + end3_(other.end3_), + current3_(other.current3_), + begin4_(other.begin4_), + end4_(other.end4_), + current4_(other.current4_), + begin5_(other.begin5_), + end5_(other.end5_), + current5_(other.current5_), + begin6_(other.begin6_), + end6_(other.end6_), + current6_(other.current6_), + begin7_(other.begin7_), + end7_(other.end7_), + current7_(other.current7_), + begin8_(other.begin8_), + end8_(other.end8_), + current8_(other.current8_), + begin9_(other.begin9_), + end9_(other.end9_), + current9_(other.current9_) { + ComputeCurrentValue(); + } + + void ComputeCurrentValue() { + if (!AtEnd()) + current_value_ = ParamType(*current1_, *current2_, *current3_, + *current4_, *current5_, *current6_, *current7_, *current8_, + *current9_); + } + bool AtEnd() const { + // We must report iterator past the end of the range when either of the + // component iterators has reached the end of its range. + return + current1_ == end1_ || + current2_ == end2_ || + current3_ == end3_ || + current4_ == end4_ || + current5_ == end5_ || + current6_ == end6_ || + current7_ == end7_ || + current8_ == end8_ || + current9_ == end9_; + } + + // No implementation - assignment is unsupported. + void operator=(const Iterator& other); + + const ParamGeneratorInterface* const base_; + // begin[i]_ and end[i]_ define the i-th range that Iterator traverses. + // current[i]_ is the actual traversing iterator. + const typename ParamGenerator::iterator begin1_; + const typename ParamGenerator::iterator end1_; + typename ParamGenerator::iterator current1_; + const typename ParamGenerator::iterator begin2_; + const typename ParamGenerator::iterator end2_; + typename ParamGenerator::iterator current2_; + const typename ParamGenerator::iterator begin3_; + const typename ParamGenerator::iterator end3_; + typename ParamGenerator::iterator current3_; + const typename ParamGenerator::iterator begin4_; + const typename ParamGenerator::iterator end4_; + typename ParamGenerator::iterator current4_; + const typename ParamGenerator::iterator begin5_; + const typename ParamGenerator::iterator end5_; + typename ParamGenerator::iterator current5_; + const typename ParamGenerator::iterator begin6_; + const typename ParamGenerator::iterator end6_; + typename ParamGenerator::iterator current6_; + const typename ParamGenerator::iterator begin7_; + const typename ParamGenerator::iterator end7_; + typename ParamGenerator::iterator current7_; + const typename ParamGenerator::iterator begin8_; + const typename ParamGenerator::iterator end8_; + typename ParamGenerator::iterator current8_; + const typename ParamGenerator::iterator begin9_; + const typename ParamGenerator::iterator end9_; + typename ParamGenerator::iterator current9_; + ParamType current_value_; + }; // class CartesianProductGenerator9::Iterator + + // No implementation - assignment is unsupported. + void operator=(const CartesianProductGenerator9& other); + + const ParamGenerator g1_; + const ParamGenerator g2_; + const ParamGenerator g3_; + const ParamGenerator g4_; + const ParamGenerator g5_; + const ParamGenerator g6_; + const ParamGenerator g7_; + const ParamGenerator g8_; + const ParamGenerator g9_; +}; // class CartesianProductGenerator9 + + +template +class CartesianProductGenerator10 + : public ParamGeneratorInterface< ::std::tr1::tuple > { + public: + typedef ::std::tr1::tuple ParamType; + + CartesianProductGenerator10(const ParamGenerator& g1, + const ParamGenerator& g2, const ParamGenerator& g3, + const ParamGenerator& g4, const ParamGenerator& g5, + const ParamGenerator& g6, const ParamGenerator& g7, + const ParamGenerator& g8, const ParamGenerator& g9, + const ParamGenerator& g10) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7), g8_(g8), + g9_(g9), g10_(g10) {} + virtual ~CartesianProductGenerator10() {} + + virtual ParamIteratorInterface* Begin() const { + return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_, + g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin(), g6_, g6_.begin(), g7_, + g7_.begin(), g8_, g8_.begin(), g9_, g9_.begin(), g10_, g10_.begin()); + } + virtual ParamIteratorInterface* End() const { + return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(), + g4_, g4_.end(), g5_, g5_.end(), g6_, g6_.end(), g7_, g7_.end(), g8_, + g8_.end(), g9_, g9_.end(), g10_, g10_.end()); + } + + private: + class Iterator : public ParamIteratorInterface { + public: + Iterator(const ParamGeneratorInterface* base, + const ParamGenerator& g1, + const typename ParamGenerator::iterator& current1, + const ParamGenerator& g2, + const typename ParamGenerator::iterator& current2, + const ParamGenerator& g3, + const typename ParamGenerator::iterator& current3, + const ParamGenerator& g4, + const typename ParamGenerator::iterator& current4, + const ParamGenerator& g5, + const typename ParamGenerator::iterator& current5, + const ParamGenerator& g6, + const typename ParamGenerator::iterator& current6, + const ParamGenerator& g7, + const typename ParamGenerator::iterator& current7, + const ParamGenerator& g8, + const typename ParamGenerator::iterator& current8, + const ParamGenerator& g9, + const typename ParamGenerator::iterator& current9, + const ParamGenerator& g10, + const typename ParamGenerator::iterator& current10) + : base_(base), + begin1_(g1.begin()), end1_(g1.end()), current1_(current1), + begin2_(g2.begin()), end2_(g2.end()), current2_(current2), + begin3_(g3.begin()), end3_(g3.end()), current3_(current3), + begin4_(g4.begin()), end4_(g4.end()), current4_(current4), + begin5_(g5.begin()), end5_(g5.end()), current5_(current5), + begin6_(g6.begin()), end6_(g6.end()), current6_(current6), + begin7_(g7.begin()), end7_(g7.end()), current7_(current7), + begin8_(g8.begin()), end8_(g8.end()), current8_(current8), + begin9_(g9.begin()), end9_(g9.end()), current9_(current9), + begin10_(g10.begin()), end10_(g10.end()), current10_(current10) { + ComputeCurrentValue(); + } + virtual ~Iterator() {} + + virtual const ParamGeneratorInterface* BaseGenerator() const { + return base_; + } + // Advance should not be called on beyond-of-range iterators + // so no component iterators must be beyond end of range, either. + virtual void Advance() { + assert(!AtEnd()); + ++current10_; + if (current10_ == end10_) { + current10_ = begin10_; + ++current9_; + } + if (current9_ == end9_) { + current9_ = begin9_; + ++current8_; + } + if (current8_ == end8_) { + current8_ = begin8_; + ++current7_; + } + if (current7_ == end7_) { + current7_ = begin7_; + ++current6_; + } + if (current6_ == end6_) { + current6_ = begin6_; + ++current5_; + } + if (current5_ == end5_) { + current5_ = begin5_; + ++current4_; + } + if (current4_ == end4_) { + current4_ = begin4_; + ++current3_; + } + if (current3_ == end3_) { + current3_ = begin3_; + ++current2_; + } + if (current2_ == end2_) { + current2_ = begin2_; + ++current1_; + } + ComputeCurrentValue(); + } + virtual ParamIteratorInterface* Clone() const { + return new Iterator(*this); + } + virtual const ParamType* Current() const { return ¤t_value_; } + virtual bool Equals(const ParamIteratorInterface& other) const { + // Having the same base generator guarantees that the other + // iterator is of the same type and we can downcast. + GTEST_CHECK_(BaseGenerator() == other.BaseGenerator()) + << "The program attempted to compare iterators " + << "from different generators." << std::endl; + const Iterator* typed_other = + CheckedDowncastToActualType(&other); + // We must report iterators equal if they both point beyond their + // respective ranges. That can happen in a variety of fashions, + // so we have to consult AtEnd(). + return (AtEnd() && typed_other->AtEnd()) || + ( + current1_ == typed_other->current1_ && + current2_ == typed_other->current2_ && + current3_ == typed_other->current3_ && + current4_ == typed_other->current4_ && + current5_ == typed_other->current5_ && + current6_ == typed_other->current6_ && + current7_ == typed_other->current7_ && + current8_ == typed_other->current8_ && + current9_ == typed_other->current9_ && + current10_ == typed_other->current10_); + } + + private: + Iterator(const Iterator& other) + : base_(other.base_), + begin1_(other.begin1_), + end1_(other.end1_), + current1_(other.current1_), + begin2_(other.begin2_), + end2_(other.end2_), + current2_(other.current2_), + begin3_(other.begin3_), + end3_(other.end3_), + current3_(other.current3_), + begin4_(other.begin4_), + end4_(other.end4_), + current4_(other.current4_), + begin5_(other.begin5_), + end5_(other.end5_), + current5_(other.current5_), + begin6_(other.begin6_), + end6_(other.end6_), + current6_(other.current6_), + begin7_(other.begin7_), + end7_(other.end7_), + current7_(other.current7_), + begin8_(other.begin8_), + end8_(other.end8_), + current8_(other.current8_), + begin9_(other.begin9_), + end9_(other.end9_), + current9_(other.current9_), + begin10_(other.begin10_), + end10_(other.end10_), + current10_(other.current10_) { + ComputeCurrentValue(); + } + + void ComputeCurrentValue() { + if (!AtEnd()) + current_value_ = ParamType(*current1_, *current2_, *current3_, + *current4_, *current5_, *current6_, *current7_, *current8_, + *current9_, *current10_); + } + bool AtEnd() const { + // We must report iterator past the end of the range when either of the + // component iterators has reached the end of its range. + return + current1_ == end1_ || + current2_ == end2_ || + current3_ == end3_ || + current4_ == end4_ || + current5_ == end5_ || + current6_ == end6_ || + current7_ == end7_ || + current8_ == end8_ || + current9_ == end9_ || + current10_ == end10_; + } + + // No implementation - assignment is unsupported. + void operator=(const Iterator& other); + + const ParamGeneratorInterface* const base_; + // begin[i]_ and end[i]_ define the i-th range that Iterator traverses. + // current[i]_ is the actual traversing iterator. + const typename ParamGenerator::iterator begin1_; + const typename ParamGenerator::iterator end1_; + typename ParamGenerator::iterator current1_; + const typename ParamGenerator::iterator begin2_; + const typename ParamGenerator::iterator end2_; + typename ParamGenerator::iterator current2_; + const typename ParamGenerator::iterator begin3_; + const typename ParamGenerator::iterator end3_; + typename ParamGenerator::iterator current3_; + const typename ParamGenerator::iterator begin4_; + const typename ParamGenerator::iterator end4_; + typename ParamGenerator::iterator current4_; + const typename ParamGenerator::iterator begin5_; + const typename ParamGenerator::iterator end5_; + typename ParamGenerator::iterator current5_; + const typename ParamGenerator::iterator begin6_; + const typename ParamGenerator::iterator end6_; + typename ParamGenerator::iterator current6_; + const typename ParamGenerator::iterator begin7_; + const typename ParamGenerator::iterator end7_; + typename ParamGenerator::iterator current7_; + const typename ParamGenerator::iterator begin8_; + const typename ParamGenerator::iterator end8_; + typename ParamGenerator::iterator current8_; + const typename ParamGenerator::iterator begin9_; + const typename ParamGenerator::iterator end9_; + typename ParamGenerator::iterator current9_; + const typename ParamGenerator::iterator begin10_; + const typename ParamGenerator::iterator end10_; + typename ParamGenerator::iterator current10_; + ParamType current_value_; + }; // class CartesianProductGenerator10::Iterator + + // No implementation - assignment is unsupported. + void operator=(const CartesianProductGenerator10& other); + + const ParamGenerator g1_; + const ParamGenerator g2_; + const ParamGenerator g3_; + const ParamGenerator g4_; + const ParamGenerator g5_; + const ParamGenerator g6_; + const ParamGenerator g7_; + const ParamGenerator g8_; + const ParamGenerator g9_; + const ParamGenerator g10_; +}; // class CartesianProductGenerator10 + + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// Helper classes providing Combine() with polymorphic features. They allow +// casting CartesianProductGeneratorN to ParamGenerator if T is +// convertible to U. +// +template +class CartesianProductHolder2 { + public: +CartesianProductHolder2(const Generator1& g1, const Generator2& g2) + : g1_(g1), g2_(g2) {} + template + operator ParamGenerator< ::std::tr1::tuple >() const { + return ParamGenerator< ::std::tr1::tuple >( + new CartesianProductGenerator2( + static_cast >(g1_), + static_cast >(g2_))); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const CartesianProductHolder2& other); + + const Generator1 g1_; + const Generator2 g2_; +}; // class CartesianProductHolder2 + +template +class CartesianProductHolder3 { + public: +CartesianProductHolder3(const Generator1& g1, const Generator2& g2, + const Generator3& g3) + : g1_(g1), g2_(g2), g3_(g3) {} + template + operator ParamGenerator< ::std::tr1::tuple >() const { + return ParamGenerator< ::std::tr1::tuple >( + new CartesianProductGenerator3( + static_cast >(g1_), + static_cast >(g2_), + static_cast >(g3_))); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const CartesianProductHolder3& other); + + const Generator1 g1_; + const Generator2 g2_; + const Generator3 g3_; +}; // class CartesianProductHolder3 + +template +class CartesianProductHolder4 { + public: +CartesianProductHolder4(const Generator1& g1, const Generator2& g2, + const Generator3& g3, const Generator4& g4) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4) {} + template + operator ParamGenerator< ::std::tr1::tuple >() const { + return ParamGenerator< ::std::tr1::tuple >( + new CartesianProductGenerator4( + static_cast >(g1_), + static_cast >(g2_), + static_cast >(g3_), + static_cast >(g4_))); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const CartesianProductHolder4& other); + + const Generator1 g1_; + const Generator2 g2_; + const Generator3 g3_; + const Generator4 g4_; +}; // class CartesianProductHolder4 + +template +class CartesianProductHolder5 { + public: +CartesianProductHolder5(const Generator1& g1, const Generator2& g2, + const Generator3& g3, const Generator4& g4, const Generator5& g5) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5) {} + template + operator ParamGenerator< ::std::tr1::tuple >() const { + return ParamGenerator< ::std::tr1::tuple >( + new CartesianProductGenerator5( + static_cast >(g1_), + static_cast >(g2_), + static_cast >(g3_), + static_cast >(g4_), + static_cast >(g5_))); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const CartesianProductHolder5& other); + + const Generator1 g1_; + const Generator2 g2_; + const Generator3 g3_; + const Generator4 g4_; + const Generator5 g5_; +}; // class CartesianProductHolder5 + +template +class CartesianProductHolder6 { + public: +CartesianProductHolder6(const Generator1& g1, const Generator2& g2, + const Generator3& g3, const Generator4& g4, const Generator5& g5, + const Generator6& g6) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6) {} + template + operator ParamGenerator< ::std::tr1::tuple >() const { + return ParamGenerator< ::std::tr1::tuple >( + new CartesianProductGenerator6( + static_cast >(g1_), + static_cast >(g2_), + static_cast >(g3_), + static_cast >(g4_), + static_cast >(g5_), + static_cast >(g6_))); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const CartesianProductHolder6& other); + + const Generator1 g1_; + const Generator2 g2_; + const Generator3 g3_; + const Generator4 g4_; + const Generator5 g5_; + const Generator6 g6_; +}; // class CartesianProductHolder6 + +template +class CartesianProductHolder7 { + public: +CartesianProductHolder7(const Generator1& g1, const Generator2& g2, + const Generator3& g3, const Generator4& g4, const Generator5& g5, + const Generator6& g6, const Generator7& g7) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7) {} + template + operator ParamGenerator< ::std::tr1::tuple >() const { + return ParamGenerator< ::std::tr1::tuple >( + new CartesianProductGenerator7( + static_cast >(g1_), + static_cast >(g2_), + static_cast >(g3_), + static_cast >(g4_), + static_cast >(g5_), + static_cast >(g6_), + static_cast >(g7_))); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const CartesianProductHolder7& other); + + const Generator1 g1_; + const Generator2 g2_; + const Generator3 g3_; + const Generator4 g4_; + const Generator5 g5_; + const Generator6 g6_; + const Generator7 g7_; +}; // class CartesianProductHolder7 + +template +class CartesianProductHolder8 { + public: +CartesianProductHolder8(const Generator1& g1, const Generator2& g2, + const Generator3& g3, const Generator4& g4, const Generator5& g5, + const Generator6& g6, const Generator7& g7, const Generator8& g8) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7), + g8_(g8) {} + template + operator ParamGenerator< ::std::tr1::tuple >() const { + return ParamGenerator< ::std::tr1::tuple >( + new CartesianProductGenerator8( + static_cast >(g1_), + static_cast >(g2_), + static_cast >(g3_), + static_cast >(g4_), + static_cast >(g5_), + static_cast >(g6_), + static_cast >(g7_), + static_cast >(g8_))); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const CartesianProductHolder8& other); + + const Generator1 g1_; + const Generator2 g2_; + const Generator3 g3_; + const Generator4 g4_; + const Generator5 g5_; + const Generator6 g6_; + const Generator7 g7_; + const Generator8 g8_; +}; // class CartesianProductHolder8 + +template +class CartesianProductHolder9 { + public: +CartesianProductHolder9(const Generator1& g1, const Generator2& g2, + const Generator3& g3, const Generator4& g4, const Generator5& g5, + const Generator6& g6, const Generator7& g7, const Generator8& g8, + const Generator9& g9) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7), g8_(g8), + g9_(g9) {} + template + operator ParamGenerator< ::std::tr1::tuple >() const { + return ParamGenerator< ::std::tr1::tuple >( + new CartesianProductGenerator9( + static_cast >(g1_), + static_cast >(g2_), + static_cast >(g3_), + static_cast >(g4_), + static_cast >(g5_), + static_cast >(g6_), + static_cast >(g7_), + static_cast >(g8_), + static_cast >(g9_))); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const CartesianProductHolder9& other); + + const Generator1 g1_; + const Generator2 g2_; + const Generator3 g3_; + const Generator4 g4_; + const Generator5 g5_; + const Generator6 g6_; + const Generator7 g7_; + const Generator8 g8_; + const Generator9 g9_; +}; // class CartesianProductHolder9 + +template +class CartesianProductHolder10 { + public: +CartesianProductHolder10(const Generator1& g1, const Generator2& g2, + const Generator3& g3, const Generator4& g4, const Generator5& g5, + const Generator6& g6, const Generator7& g7, const Generator8& g8, + const Generator9& g9, const Generator10& g10) + : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7), g8_(g8), + g9_(g9), g10_(g10) {} + template + operator ParamGenerator< ::std::tr1::tuple >() const { + return ParamGenerator< ::std::tr1::tuple >( + new CartesianProductGenerator10( + static_cast >(g1_), + static_cast >(g2_), + static_cast >(g3_), + static_cast >(g4_), + static_cast >(g5_), + static_cast >(g6_), + static_cast >(g7_), + static_cast >(g8_), + static_cast >(g9_), + static_cast >(g10_))); + } + + private: + // No implementation - assignment is unsupported. + void operator=(const CartesianProductHolder10& other); + + const Generator1 g1_; + const Generator2 g2_; + const Generator3 g3_; + const Generator4 g4_; + const Generator5 g5_; + const Generator6 g6_; + const Generator7 g7_; + const Generator8 g8_; + const Generator9 g9_; + const Generator10 g10_; +}; // class CartesianProductHolder10 + +# endif // GTEST_HAS_COMBINE + +} // namespace internal +} // namespace testing + +#endif // GTEST_HAS_PARAM_TEST + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_GENERATED_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util.h new file mode 100644 index 0000000000..74a4185551 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-param-util.h @@ -0,0 +1,619 @@ +// Copyright 2008 Google Inc. +// All Rights Reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: vladl@google.com (Vlad Losev) + +// Type and function utilities for implementing parameterized tests. + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_H_ + +#include +#include +#include + +// scripts/fuse_gtest.py depends on gtest's own header being #included +// *unconditionally*. Therefore these #includes cannot be moved +// inside #if GTEST_HAS_PARAM_TEST. +#include "gtest/internal/gtest-internal.h" +#include "gtest/internal/gtest-linked_ptr.h" +#include "gtest/internal/gtest-port.h" +#include "gtest/gtest-printers.h" + +#if GTEST_HAS_PARAM_TEST + +namespace testing { +namespace internal { + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// Outputs a message explaining invalid registration of different +// fixture class for the same test case. This may happen when +// TEST_P macro is used to define two tests with the same name +// but in different namespaces. +GTEST_API_ void ReportInvalidTestCaseType(const char* test_case_name, + const char* file, int line); + +template class ParamGeneratorInterface; +template class ParamGenerator; + +// Interface for iterating over elements provided by an implementation +// of ParamGeneratorInterface. +template +class ParamIteratorInterface { + public: + virtual ~ParamIteratorInterface() {} + // A pointer to the base generator instance. + // Used only for the purposes of iterator comparison + // to make sure that two iterators belong to the same generator. + virtual const ParamGeneratorInterface* BaseGenerator() const = 0; + // Advances iterator to point to the next element + // provided by the generator. The caller is responsible + // for not calling Advance() on an iterator equal to + // BaseGenerator()->End(). + virtual void Advance() = 0; + // Clones the iterator object. Used for implementing copy semantics + // of ParamIterator. + virtual ParamIteratorInterface* Clone() const = 0; + // Dereferences the current iterator and provides (read-only) access + // to the pointed value. It is the caller's responsibility not to call + // Current() on an iterator equal to BaseGenerator()->End(). + // Used for implementing ParamGenerator::operator*(). + virtual const T* Current() const = 0; + // Determines whether the given iterator and other point to the same + // element in the sequence generated by the generator. + // Used for implementing ParamGenerator::operator==(). + virtual bool Equals(const ParamIteratorInterface& other) const = 0; +}; + +// Class iterating over elements provided by an implementation of +// ParamGeneratorInterface. It wraps ParamIteratorInterface +// and implements the const forward iterator concept. +template +class ParamIterator { + public: + typedef T value_type; + typedef const T& reference; + typedef ptrdiff_t difference_type; + + // ParamIterator assumes ownership of the impl_ pointer. + ParamIterator(const ParamIterator& other) : impl_(other.impl_->Clone()) {} + ParamIterator& operator=(const ParamIterator& other) { + if (this != &other) + impl_.reset(other.impl_->Clone()); + return *this; + } + + const T& operator*() const { return *impl_->Current(); } + const T* operator->() const { return impl_->Current(); } + // Prefix version of operator++. + ParamIterator& operator++() { + impl_->Advance(); + return *this; + } + // Postfix version of operator++. + ParamIterator operator++(int /*unused*/) { + ParamIteratorInterface* clone = impl_->Clone(); + impl_->Advance(); + return ParamIterator(clone); + } + bool operator==(const ParamIterator& other) const { + return impl_.get() == other.impl_.get() || impl_->Equals(*other.impl_); + } + bool operator!=(const ParamIterator& other) const { + return !(*this == other); + } + + private: + friend class ParamGenerator; + explicit ParamIterator(ParamIteratorInterface* impl) : impl_(impl) {} + scoped_ptr > impl_; +}; + +// ParamGeneratorInterface is the binary interface to access generators +// defined in other translation units. +template +class ParamGeneratorInterface { + public: + typedef T ParamType; + + virtual ~ParamGeneratorInterface() {} + + // Generator interface definition + virtual ParamIteratorInterface* Begin() const = 0; + virtual ParamIteratorInterface* End() const = 0; +}; + +// Wraps ParamGeneratorInterface and provides general generator syntax +// compatible with the STL Container concept. +// This class implements copy initialization semantics and the contained +// ParamGeneratorInterface instance is shared among all copies +// of the original object. This is possible because that instance is immutable. +template +class ParamGenerator { + public: + typedef ParamIterator iterator; + + explicit ParamGenerator(ParamGeneratorInterface* impl) : impl_(impl) {} + ParamGenerator(const ParamGenerator& other) : impl_(other.impl_) {} + + ParamGenerator& operator=(const ParamGenerator& other) { + impl_ = other.impl_; + return *this; + } + + iterator begin() const { return iterator(impl_->Begin()); } + iterator end() const { return iterator(impl_->End()); } + + private: + linked_ptr > impl_; +}; + +// Generates values from a range of two comparable values. Can be used to +// generate sequences of user-defined types that implement operator+() and +// operator<(). +// This class is used in the Range() function. +template +class RangeGenerator : public ParamGeneratorInterface { + public: + RangeGenerator(T begin, T end, IncrementT step) + : begin_(begin), end_(end), + step_(step), end_index_(CalculateEndIndex(begin, end, step)) {} + virtual ~RangeGenerator() {} + + virtual ParamIteratorInterface* Begin() const { + return new Iterator(this, begin_, 0, step_); + } + virtual ParamIteratorInterface* End() const { + return new Iterator(this, end_, end_index_, step_); + } + + private: + class Iterator : public ParamIteratorInterface { + public: + Iterator(const ParamGeneratorInterface* base, T value, int index, + IncrementT step) + : base_(base), value_(value), index_(index), step_(step) {} + virtual ~Iterator() {} + + virtual const ParamGeneratorInterface* BaseGenerator() const { + return base_; + } + virtual void Advance() { + value_ = value_ + step_; + index_++; + } + virtual ParamIteratorInterface* Clone() const { + return new Iterator(*this); + } + virtual const T* Current() const { return &value_; } + virtual bool Equals(const ParamIteratorInterface& other) const { + // Having the same base generator guarantees that the other + // iterator is of the same type and we can downcast. + GTEST_CHECK_(BaseGenerator() == other.BaseGenerator()) + << "The program attempted to compare iterators " + << "from different generators." << std::endl; + const int other_index = + CheckedDowncastToActualType(&other)->index_; + return index_ == other_index; + } + + private: + Iterator(const Iterator& other) + : ParamIteratorInterface(), + base_(other.base_), value_(other.value_), index_(other.index_), + step_(other.step_) {} + + // No implementation - assignment is unsupported. + void operator=(const Iterator& other); + + const ParamGeneratorInterface* const base_; + T value_; + int index_; + const IncrementT step_; + }; // class RangeGenerator::Iterator + + static int CalculateEndIndex(const T& begin, + const T& end, + const IncrementT& step) { + int end_index = 0; + for (T i = begin; i < end; i = i + step) + end_index++; + return end_index; + } + + // No implementation - assignment is unsupported. + void operator=(const RangeGenerator& other); + + const T begin_; + const T end_; + const IncrementT step_; + // The index for the end() iterator. All the elements in the generated + // sequence are indexed (0-based) to aid iterator comparison. + const int end_index_; +}; // class RangeGenerator + + +// Generates values from a pair of STL-style iterators. Used in the +// ValuesIn() function. The elements are copied from the source range +// since the source can be located on the stack, and the generator +// is likely to persist beyond that stack frame. +template +class ValuesInIteratorRangeGenerator : public ParamGeneratorInterface { + public: + template + ValuesInIteratorRangeGenerator(ForwardIterator begin, ForwardIterator end) + : container_(begin, end) {} + virtual ~ValuesInIteratorRangeGenerator() {} + + virtual ParamIteratorInterface* Begin() const { + return new Iterator(this, container_.begin()); + } + virtual ParamIteratorInterface* End() const { + return new Iterator(this, container_.end()); + } + + private: + typedef typename ::std::vector ContainerType; + + class Iterator : public ParamIteratorInterface { + public: + Iterator(const ParamGeneratorInterface* base, + typename ContainerType::const_iterator iterator) + : base_(base), iterator_(iterator) {} + virtual ~Iterator() {} + + virtual const ParamGeneratorInterface* BaseGenerator() const { + return base_; + } + virtual void Advance() { + ++iterator_; + value_.reset(); + } + virtual ParamIteratorInterface* Clone() const { + return new Iterator(*this); + } + // We need to use cached value referenced by iterator_ because *iterator_ + // can return a temporary object (and of type other then T), so just + // having "return &*iterator_;" doesn't work. + // value_ is updated here and not in Advance() because Advance() + // can advance iterator_ beyond the end of the range, and we cannot + // detect that fact. The client code, on the other hand, is + // responsible for not calling Current() on an out-of-range iterator. + virtual const T* Current() const { + if (value_.get() == NULL) + value_.reset(new T(*iterator_)); + return value_.get(); + } + virtual bool Equals(const ParamIteratorInterface& other) const { + // Having the same base generator guarantees that the other + // iterator is of the same type and we can downcast. + GTEST_CHECK_(BaseGenerator() == other.BaseGenerator()) + << "The program attempted to compare iterators " + << "from different generators." << std::endl; + return iterator_ == + CheckedDowncastToActualType(&other)->iterator_; + } + + private: + Iterator(const Iterator& other) + // The explicit constructor call suppresses a false warning + // emitted by gcc when supplied with the -Wextra option. + : ParamIteratorInterface(), + base_(other.base_), + iterator_(other.iterator_) {} + + const ParamGeneratorInterface* const base_; + typename ContainerType::const_iterator iterator_; + // A cached value of *iterator_. We keep it here to allow access by + // pointer in the wrapping iterator's operator->(). + // value_ needs to be mutable to be accessed in Current(). + // Use of scoped_ptr helps manage cached value's lifetime, + // which is bound by the lifespan of the iterator itself. + mutable scoped_ptr value_; + }; // class ValuesInIteratorRangeGenerator::Iterator + + // No implementation - assignment is unsupported. + void operator=(const ValuesInIteratorRangeGenerator& other); + + const ContainerType container_; +}; // class ValuesInIteratorRangeGenerator + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// Stores a parameter value and later creates tests parameterized with that +// value. +template +class ParameterizedTestFactory : public TestFactoryBase { + public: + typedef typename TestClass::ParamType ParamType; + explicit ParameterizedTestFactory(ParamType parameter) : + parameter_(parameter) {} + virtual Test* CreateTest() { + TestClass::SetParam(¶meter_); + return new TestClass(); + } + + private: + const ParamType parameter_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(ParameterizedTestFactory); +}; + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// TestMetaFactoryBase is a base class for meta-factories that create +// test factories for passing into MakeAndRegisterTestInfo function. +template +class TestMetaFactoryBase { + public: + virtual ~TestMetaFactoryBase() {} + + virtual TestFactoryBase* CreateTestFactory(ParamType parameter) = 0; +}; + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// TestMetaFactory creates test factories for passing into +// MakeAndRegisterTestInfo function. Since MakeAndRegisterTestInfo receives +// ownership of test factory pointer, same factory object cannot be passed +// into that method twice. But ParameterizedTestCaseInfo is going to call +// it for each Test/Parameter value combination. Thus it needs meta factory +// creator class. +template +class TestMetaFactory + : public TestMetaFactoryBase { + public: + typedef typename TestCase::ParamType ParamType; + + TestMetaFactory() {} + + virtual TestFactoryBase* CreateTestFactory(ParamType parameter) { + return new ParameterizedTestFactory(parameter); + } + + private: + GTEST_DISALLOW_COPY_AND_ASSIGN_(TestMetaFactory); +}; + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// ParameterizedTestCaseInfoBase is a generic interface +// to ParameterizedTestCaseInfo classes. ParameterizedTestCaseInfoBase +// accumulates test information provided by TEST_P macro invocations +// and generators provided by INSTANTIATE_TEST_CASE_P macro invocations +// and uses that information to register all resulting test instances +// in RegisterTests method. The ParameterizeTestCaseRegistry class holds +// a collection of pointers to the ParameterizedTestCaseInfo objects +// and calls RegisterTests() on each of them when asked. +class ParameterizedTestCaseInfoBase { + public: + virtual ~ParameterizedTestCaseInfoBase() {} + + // Base part of test case name for display purposes. + virtual const string& GetTestCaseName() const = 0; + // Test case id to verify identity. + virtual TypeId GetTestCaseTypeId() const = 0; + // UnitTest class invokes this method to register tests in this + // test case right before running them in RUN_ALL_TESTS macro. + // This method should not be called more then once on any single + // instance of a ParameterizedTestCaseInfoBase derived class. + virtual void RegisterTests() = 0; + + protected: + ParameterizedTestCaseInfoBase() {} + + private: + GTEST_DISALLOW_COPY_AND_ASSIGN_(ParameterizedTestCaseInfoBase); +}; + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// ParameterizedTestCaseInfo accumulates tests obtained from TEST_P +// macro invocations for a particular test case and generators +// obtained from INSTANTIATE_TEST_CASE_P macro invocations for that +// test case. It registers tests with all values generated by all +// generators when asked. +template +class ParameterizedTestCaseInfo : public ParameterizedTestCaseInfoBase { + public: + // ParamType and GeneratorCreationFunc are private types but are required + // for declarations of public methods AddTestPattern() and + // AddTestCaseInstantiation(). + typedef typename TestCase::ParamType ParamType; + // A function that returns an instance of appropriate generator type. + typedef ParamGenerator(GeneratorCreationFunc)(); + + explicit ParameterizedTestCaseInfo(const char* name) + : test_case_name_(name) {} + + // Test case base name for display purposes. + virtual const string& GetTestCaseName() const { return test_case_name_; } + // Test case id to verify identity. + virtual TypeId GetTestCaseTypeId() const { return GetTypeId(); } + // TEST_P macro uses AddTestPattern() to record information + // about a single test in a LocalTestInfo structure. + // test_case_name is the base name of the test case (without invocation + // prefix). test_base_name is the name of an individual test without + // parameter index. For the test SequenceA/FooTest.DoBar/1 FooTest is + // test case base name and DoBar is test base name. + void AddTestPattern(const char* test_case_name, + const char* test_base_name, + TestMetaFactoryBase* meta_factory) { + tests_.push_back(linked_ptr(new TestInfo(test_case_name, + test_base_name, + meta_factory))); + } + // INSTANTIATE_TEST_CASE_P macro uses AddGenerator() to record information + // about a generator. + int AddTestCaseInstantiation(const string& instantiation_name, + GeneratorCreationFunc* func, + const char* /* file */, + int /* line */) { + instantiations_.push_back(::std::make_pair(instantiation_name, func)); + return 0; // Return value used only to run this method in namespace scope. + } + // UnitTest class invokes this method to register tests in this test case + // test cases right before running tests in RUN_ALL_TESTS macro. + // This method should not be called more then once on any single + // instance of a ParameterizedTestCaseInfoBase derived class. + // UnitTest has a guard to prevent from calling this method more then once. + virtual void RegisterTests() { + for (typename TestInfoContainer::iterator test_it = tests_.begin(); + test_it != tests_.end(); ++test_it) { + linked_ptr test_info = *test_it; + for (typename InstantiationContainer::iterator gen_it = + instantiations_.begin(); gen_it != instantiations_.end(); + ++gen_it) { + const string& instantiation_name = gen_it->first; + ParamGenerator generator((*gen_it->second)()); + + Message test_case_name_stream; + if ( !instantiation_name.empty() ) + test_case_name_stream << instantiation_name << "/"; + test_case_name_stream << test_info->test_case_base_name; + + int i = 0; + for (typename ParamGenerator::iterator param_it = + generator.begin(); + param_it != generator.end(); ++param_it, ++i) { + Message test_name_stream; + test_name_stream << test_info->test_base_name << "/" << i; + MakeAndRegisterTestInfo( + test_case_name_stream.GetString().c_str(), + test_name_stream.GetString().c_str(), + NULL, // No type parameter. + PrintToString(*param_it).c_str(), + GetTestCaseTypeId(), + TestCase::SetUpTestCase, + TestCase::TearDownTestCase, + test_info->test_meta_factory->CreateTestFactory(*param_it)); + } // for param_it + } // for gen_it + } // for test_it + } // RegisterTests + + private: + // LocalTestInfo structure keeps information about a single test registered + // with TEST_P macro. + struct TestInfo { + TestInfo(const char* a_test_case_base_name, + const char* a_test_base_name, + TestMetaFactoryBase* a_test_meta_factory) : + test_case_base_name(a_test_case_base_name), + test_base_name(a_test_base_name), + test_meta_factory(a_test_meta_factory) {} + + const string test_case_base_name; + const string test_base_name; + const scoped_ptr > test_meta_factory; + }; + typedef ::std::vector > TestInfoContainer; + // Keeps pairs of + // received from INSTANTIATE_TEST_CASE_P macros. + typedef ::std::vector > + InstantiationContainer; + + const string test_case_name_; + TestInfoContainer tests_; + InstantiationContainer instantiations_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(ParameterizedTestCaseInfo); +}; // class ParameterizedTestCaseInfo + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// ParameterizedTestCaseRegistry contains a map of ParameterizedTestCaseInfoBase +// classes accessed by test case names. TEST_P and INSTANTIATE_TEST_CASE_P +// macros use it to locate their corresponding ParameterizedTestCaseInfo +// descriptors. +class ParameterizedTestCaseRegistry { + public: + ParameterizedTestCaseRegistry() {} + ~ParameterizedTestCaseRegistry() { + for (TestCaseInfoContainer::iterator it = test_case_infos_.begin(); + it != test_case_infos_.end(); ++it) { + delete *it; + } + } + + // Looks up or creates and returns a structure containing information about + // tests and instantiations of a particular test case. + template + ParameterizedTestCaseInfo* GetTestCasePatternHolder( + const char* test_case_name, + const char* file, + int line) { + ParameterizedTestCaseInfo* typed_test_info = NULL; + for (TestCaseInfoContainer::iterator it = test_case_infos_.begin(); + it != test_case_infos_.end(); ++it) { + if ((*it)->GetTestCaseName() == test_case_name) { + if ((*it)->GetTestCaseTypeId() != GetTypeId()) { + // Complain about incorrect usage of Google Test facilities + // and terminate the program since we cannot guaranty correct + // test case setup and tear-down in this case. + ReportInvalidTestCaseType(test_case_name, file, line); + posix::Abort(); + } else { + // At this point we are sure that the object we found is of the same + // type we are looking for, so we downcast it to that type + // without further checks. + typed_test_info = CheckedDowncastToActualType< + ParameterizedTestCaseInfo >(*it); + } + break; + } + } + if (typed_test_info == NULL) { + typed_test_info = new ParameterizedTestCaseInfo(test_case_name); + test_case_infos_.push_back(typed_test_info); + } + return typed_test_info; + } + void RegisterTests() { + for (TestCaseInfoContainer::iterator it = test_case_infos_.begin(); + it != test_case_infos_.end(); ++it) { + (*it)->RegisterTests(); + } + } + + private: + typedef ::std::vector TestCaseInfoContainer; + + TestCaseInfoContainer test_case_infos_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(ParameterizedTestCaseRegistry); +}; + +} // namespace internal +} // namespace testing + +#endif // GTEST_HAS_PARAM_TEST + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-port.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-port.h new file mode 100644 index 0000000000..5123f24e68 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-port.h @@ -0,0 +1,1775 @@ +// Copyright 2005, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Authors: wan@google.com (Zhanyong Wan) +// +// Low-level types and utilities for porting Google Test to various +// platforms. They are subject to change without notice. DO NOT USE +// THEM IN USER CODE. + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_ + +// The user can define the following macros in the build script to +// control Google Test's behavior. If the user doesn't define a macro +// in this list, Google Test will define it. +// +// GTEST_HAS_CLONE - Define it to 1/0 to indicate that clone(2) +// is/isn't available. +// GTEST_HAS_EXCEPTIONS - Define it to 1/0 to indicate that exceptions +// are enabled. +// GTEST_HAS_GLOBAL_STRING - Define it to 1/0 to indicate that ::string +// is/isn't available (some systems define +// ::string, which is different to std::string). +// GTEST_HAS_GLOBAL_WSTRING - Define it to 1/0 to indicate that ::string +// is/isn't available (some systems define +// ::wstring, which is different to std::wstring). +// GTEST_HAS_POSIX_RE - Define it to 1/0 to indicate that POSIX regular +// expressions are/aren't available. +// GTEST_HAS_PTHREAD - Define it to 1/0 to indicate that +// is/isn't available. +// GTEST_HAS_RTTI - Define it to 1/0 to indicate that RTTI is/isn't +// enabled. +// GTEST_HAS_STD_WSTRING - Define it to 1/0 to indicate that +// std::wstring does/doesn't work (Google Test can +// be used where std::wstring is unavailable). +// GTEST_HAS_TR1_TUPLE - Define it to 1/0 to indicate tr1::tuple +// is/isn't available. +// GTEST_HAS_SEH - Define it to 1/0 to indicate whether the +// compiler supports Microsoft's "Structured +// Exception Handling". +// GTEST_HAS_STREAM_REDIRECTION +// - Define it to 1/0 to indicate whether the +// platform supports I/O stream redirection using +// dup() and dup2(). +// GTEST_USE_OWN_TR1_TUPLE - Define it to 1/0 to indicate whether Google +// Test's own tr1 tuple implementation should be +// used. Unused when the user sets +// GTEST_HAS_TR1_TUPLE to 0. +// GTEST_LINKED_AS_SHARED_LIBRARY +// - Define to 1 when compiling tests that use +// Google Test as a shared library (known as +// DLL on Windows). +// GTEST_CREATE_SHARED_LIBRARY +// - Define to 1 when compiling Google Test itself +// as a shared library. + +// This header defines the following utilities: +// +// Macros indicating the current platform (defined to 1 if compiled on +// the given platform; otherwise undefined): +// GTEST_OS_AIX - IBM AIX +// GTEST_OS_CYGWIN - Cygwin +// GTEST_OS_HPUX - HP-UX +// GTEST_OS_LINUX - Linux +// GTEST_OS_LINUX_ANDROID - Google Android +// GTEST_OS_MAC - Mac OS X +// GTEST_OS_NACL - Google Native Client (NaCl) +// GTEST_OS_SOLARIS - Sun Solaris +// GTEST_OS_SYMBIAN - Symbian +// GTEST_OS_WINDOWS - Windows (Desktop, MinGW, or Mobile) +// GTEST_OS_WINDOWS_DESKTOP - Windows Desktop +// GTEST_OS_WINDOWS_MINGW - MinGW +// GTEST_OS_WINDOWS_MOBILE - Windows Mobile +// GTEST_OS_ZOS - z/OS +// +// Among the platforms, Cygwin, Linux, Max OS X, and Windows have the +// most stable support. Since core members of the Google Test project +// don't have access to other platforms, support for them may be less +// stable. If you notice any problems on your platform, please notify +// googletestframework@googlegroups.com (patches for fixing them are +// even more welcome!). +// +// Note that it is possible that none of the GTEST_OS_* macros are defined. +// +// Macros indicating available Google Test features (defined to 1 if +// the corresponding feature is supported; otherwise undefined): +// GTEST_HAS_COMBINE - the Combine() function (for value-parameterized +// tests) +// GTEST_HAS_DEATH_TEST - death tests +// GTEST_HAS_PARAM_TEST - value-parameterized tests +// GTEST_HAS_TYPED_TEST - typed tests +// GTEST_HAS_TYPED_TEST_P - type-parameterized tests +// GTEST_USES_POSIX_RE - enhanced POSIX regex is used. Do not confuse with +// GTEST_HAS_POSIX_RE (see above) which users can +// define themselves. +// GTEST_USES_SIMPLE_RE - our own simple regex is used; +// the above two are mutually exclusive. +// GTEST_CAN_COMPARE_NULL - accepts untyped NULL in EXPECT_EQ(). +// +// Macros for basic C++ coding: +// GTEST_AMBIGUOUS_ELSE_BLOCKER_ - for disabling a gcc warning. +// GTEST_ATTRIBUTE_UNUSED_ - declares that a class' instances or a +// variable don't have to be used. +// GTEST_DISALLOW_ASSIGN_ - disables operator=. +// GTEST_DISALLOW_COPY_AND_ASSIGN_ - disables copy ctor and operator=. +// GTEST_MUST_USE_RESULT_ - declares that a function's result must be used. +// +// Synchronization: +// Mutex, MutexLock, ThreadLocal, GetThreadCount() +// - synchronization primitives. +// GTEST_IS_THREADSAFE - defined to 1 to indicate that the above +// synchronization primitives have real implementations +// and Google Test is thread-safe; or 0 otherwise. +// +// Template meta programming: +// is_pointer - as in TR1; needed on Symbian and IBM XL C/C++ only. +// IteratorTraits - partial implementation of std::iterator_traits, which +// is not available in libCstd when compiled with Sun C++. +// +// Smart pointers: +// scoped_ptr - as in TR2. +// +// Regular expressions: +// RE - a simple regular expression class using the POSIX +// Extended Regular Expression syntax on UNIX-like +// platforms, or a reduced regular exception syntax on +// other platforms, including Windows. +// +// Logging: +// GTEST_LOG_() - logs messages at the specified severity level. +// LogToStderr() - directs all log messages to stderr. +// FlushInfoLog() - flushes informational log messages. +// +// Stdout and stderr capturing: +// CaptureStdout() - starts capturing stdout. +// GetCapturedStdout() - stops capturing stdout and returns the captured +// string. +// CaptureStderr() - starts capturing stderr. +// GetCapturedStderr() - stops capturing stderr and returns the captured +// string. +// +// Integer types: +// TypeWithSize - maps an integer to a int type. +// Int32, UInt32, Int64, UInt64, TimeInMillis +// - integers of known sizes. +// BiggestInt - the biggest signed integer type. +// +// Command-line utilities: +// GTEST_FLAG() - references a flag. +// GTEST_DECLARE_*() - declares a flag. +// GTEST_DEFINE_*() - defines a flag. +// GetArgvs() - returns the command line as a vector of strings. +// +// Environment variable utilities: +// GetEnv() - gets the value of an environment variable. +// BoolFromGTestEnv() - parses a bool environment variable. +// Int32FromGTestEnv() - parses an Int32 environment variable. +// StringFromGTestEnv() - parses a string environment variable. + +#include // for isspace, etc +#include // for ptrdiff_t +#include +#include +#include +#ifndef _WIN32_WCE +# include +# include +#endif // !_WIN32_WCE + +#include // NOLINT +#include // NOLINT +#include // NOLINT + +#define GTEST_DEV_EMAIL_ "googletestframework@@googlegroups.com" +#define GTEST_FLAG_PREFIX_ "gtest_" +#define GTEST_FLAG_PREFIX_DASH_ "gtest-" +#define GTEST_FLAG_PREFIX_UPPER_ "GTEST_" +#define GTEST_NAME_ "Google Test" +#define GTEST_PROJECT_URL_ "http://code.google.com/p/googletest/" + +// Determines the version of gcc that is used to compile this. +#ifdef __GNUC__ +// 40302 means version 4.3.2. +# define GTEST_GCC_VER_ \ + (__GNUC__*10000 + __GNUC_MINOR__*100 + __GNUC_PATCHLEVEL__) +#endif // __GNUC__ + +// Determines the platform on which Google Test is compiled. +#ifdef __CYGWIN__ +# define GTEST_OS_CYGWIN 1 +#elif defined __SYMBIAN32__ +# define GTEST_OS_SYMBIAN 1 +#elif defined _WIN32 +# define GTEST_OS_WINDOWS 1 +# ifdef _WIN32_WCE +# define GTEST_OS_WINDOWS_MOBILE 1 +# elif defined(__MINGW__) || defined(__MINGW32__) +# define GTEST_OS_WINDOWS_MINGW 1 +# else +# define GTEST_OS_WINDOWS_DESKTOP 1 +# endif // _WIN32_WCE +#elif defined __APPLE__ +# define GTEST_OS_MAC 1 +#elif defined __linux__ +# define GTEST_OS_LINUX 1 +# ifdef ANDROID +# define GTEST_OS_LINUX_ANDROID 1 +# endif // ANDROID +#elif defined __MVS__ +# define GTEST_OS_ZOS 1 +#elif defined(__sun) && defined(__SVR4) +# define GTEST_OS_SOLARIS 1 +#elif defined(_AIX) +# define GTEST_OS_AIX 1 +#elif defined(__hpux) +# define GTEST_OS_HPUX 1 +#elif defined __native_client__ +# define GTEST_OS_NACL 1 +#endif // __CYGWIN__ + +// Brings in definitions for functions used in the testing::internal::posix +// namespace (read, write, close, chdir, isatty, stat). We do not currently +// use them on Windows Mobile. +#if !GTEST_OS_WINDOWS +// This assumes that non-Windows OSes provide unistd.h. For OSes where this +// is not the case, we need to include headers that provide the functions +// mentioned above. +# include +# if !GTEST_OS_NACL +// TODO(vladl@google.com): Remove this condition when Native Client SDK adds +// strings.h (tracked in +// http://code.google.com/p/nativeclient/issues/detail?id=1175). +# include // Native Client doesn't provide strings.h. +# endif +#elif !GTEST_OS_WINDOWS_MOBILE +# include +# include +#endif + +// Defines this to true iff Google Test can use POSIX regular expressions. +#ifndef GTEST_HAS_POSIX_RE +# define GTEST_HAS_POSIX_RE (!GTEST_OS_WINDOWS) +#endif + +#if GTEST_HAS_POSIX_RE + +// On some platforms, needs someone to define size_t, and +// won't compile otherwise. We can #include it here as we already +// included , which is guaranteed to define size_t through +// . +# include // NOLINT + +# define GTEST_USES_POSIX_RE 1 + +#elif GTEST_OS_WINDOWS + +// is not available on Windows. Use our own simple regex +// implementation instead. +# define GTEST_USES_SIMPLE_RE 1 + +#else + +// may not be available on this platform. Use our own +// simple regex implementation instead. +# define GTEST_USES_SIMPLE_RE 1 + +#endif // GTEST_HAS_POSIX_RE + +#ifndef GTEST_HAS_EXCEPTIONS +// The user didn't tell us whether exceptions are enabled, so we need +// to figure it out. +# if defined(_MSC_VER) || defined(__BORLANDC__) +// MSVC's and C++Builder's implementations of the STL use the _HAS_EXCEPTIONS +// macro to enable exceptions, so we'll do the same. +// Assumes that exceptions are enabled by default. +# ifndef _HAS_EXCEPTIONS +# define _HAS_EXCEPTIONS 1 +# endif // _HAS_EXCEPTIONS +# define GTEST_HAS_EXCEPTIONS _HAS_EXCEPTIONS +# elif defined(__GNUC__) && __EXCEPTIONS +// gcc defines __EXCEPTIONS to 1 iff exceptions are enabled. +# define GTEST_HAS_EXCEPTIONS 1 +# elif defined(__SUNPRO_CC) +// Sun Pro CC supports exceptions. However, there is no compile-time way of +// detecting whether they are enabled or not. Therefore, we assume that +// they are enabled unless the user tells us otherwise. +# define GTEST_HAS_EXCEPTIONS 1 +# elif defined(__IBMCPP__) && __EXCEPTIONS +// xlC defines __EXCEPTIONS to 1 iff exceptions are enabled. +# define GTEST_HAS_EXCEPTIONS 1 +# elif defined(__HP_aCC) +// Exception handling is in effect by default in HP aCC compiler. It has to +// be turned of by +noeh compiler option if desired. +# define GTEST_HAS_EXCEPTIONS 1 +# else +// For other compilers, we assume exceptions are disabled to be +// conservative. +# define GTEST_HAS_EXCEPTIONS 0 +# endif // defined(_MSC_VER) || defined(__BORLANDC__) +#endif // GTEST_HAS_EXCEPTIONS + +#if !defined(GTEST_HAS_STD_STRING) +// Even though we don't use this macro any longer, we keep it in case +// some clients still depend on it. +# define GTEST_HAS_STD_STRING 1 +#elif !GTEST_HAS_STD_STRING +// The user told us that ::std::string isn't available. +# error "Google Test cannot be used where ::std::string isn't available." +#endif // !defined(GTEST_HAS_STD_STRING) + +#ifndef GTEST_HAS_GLOBAL_STRING +// The user didn't tell us whether ::string is available, so we need +// to figure it out. + +# define GTEST_HAS_GLOBAL_STRING 0 + +#endif // GTEST_HAS_GLOBAL_STRING + +#ifndef GTEST_HAS_STD_WSTRING +// The user didn't tell us whether ::std::wstring is available, so we need +// to figure it out. +// TODO(wan@google.com): uses autoconf to detect whether ::std::wstring +// is available. + +// Cygwin 1.7 and below doesn't support ::std::wstring. +// Solaris' libc++ doesn't support it either. Android has +// no support for it at least as recent as Froyo (2.2). +# define GTEST_HAS_STD_WSTRING \ + (!(GTEST_OS_LINUX_ANDROID || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS)) + +#endif // GTEST_HAS_STD_WSTRING + +#ifndef GTEST_HAS_GLOBAL_WSTRING +// The user didn't tell us whether ::wstring is available, so we need +// to figure it out. +# define GTEST_HAS_GLOBAL_WSTRING \ + (GTEST_HAS_STD_WSTRING && GTEST_HAS_GLOBAL_STRING) +#endif // GTEST_HAS_GLOBAL_WSTRING + +// Determines whether RTTI is available. +#ifndef GTEST_HAS_RTTI +// The user didn't tell us whether RTTI is enabled, so we need to +// figure it out. + +# ifdef _MSC_VER + +# ifdef _CPPRTTI // MSVC defines this macro iff RTTI is enabled. +# define GTEST_HAS_RTTI 1 +# else +# define GTEST_HAS_RTTI 0 +# endif + +// Starting with version 4.3.2, gcc defines __GXX_RTTI iff RTTI is enabled. +# elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40302) + +# ifdef __GXX_RTTI +# define GTEST_HAS_RTTI 1 +# else +# define GTEST_HAS_RTTI 0 +# endif // __GXX_RTTI + +// Starting with version 9.0 IBM Visual Age defines __RTTI_ALL__ to 1 if +// both the typeid and dynamic_cast features are present. +# elif defined(__IBMCPP__) && (__IBMCPP__ >= 900) + +# ifdef __RTTI_ALL__ +# define GTEST_HAS_RTTI 1 +# else +# define GTEST_HAS_RTTI 0 +# endif + +# else + +// For all other compilers, we assume RTTI is enabled. +# define GTEST_HAS_RTTI 1 + +# endif // _MSC_VER + +#endif // GTEST_HAS_RTTI + +// It's this header's responsibility to #include when RTTI +// is enabled. +#if GTEST_HAS_RTTI +# include +#endif + +// Determines whether Google Test can use the pthreads library. +#ifndef GTEST_HAS_PTHREAD +// The user didn't tell us explicitly, so we assume pthreads support is +// available on Linux and Mac. +// +// To disable threading support in Google Test, add -DGTEST_HAS_PTHREAD=0 +// to your compiler flags. +# define GTEST_HAS_PTHREAD (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_HPUX) +#endif // GTEST_HAS_PTHREAD + +#if GTEST_HAS_PTHREAD +// gtest-port.h guarantees to #include when GTEST_HAS_PTHREAD is +// true. +# include // NOLINT + +// For timespec and nanosleep, used below. +# include // NOLINT +#endif + +// Determines whether Google Test can use tr1/tuple. You can define +// this macro to 0 to prevent Google Test from using tuple (any +// feature depending on tuple with be disabled in this mode). +#ifndef GTEST_HAS_TR1_TUPLE +// The user didn't tell us not to do it, so we assume it's OK. +# define GTEST_HAS_TR1_TUPLE 1 +#endif // GTEST_HAS_TR1_TUPLE + +// Determines whether Google Test's own tr1 tuple implementation +// should be used. +#ifndef GTEST_USE_OWN_TR1_TUPLE +// The user didn't tell us, so we need to figure it out. + +// We use our own TR1 tuple if we aren't sure the user has an +// implementation of it already. At this time, GCC 4.0.0+ and MSVC +// 2010 are the only mainstream compilers that come with a TR1 tuple +// implementation. NVIDIA's CUDA NVCC compiler pretends to be GCC by +// defining __GNUC__ and friends, but cannot compile GCC's tuple +// implementation. MSVC 2008 (9.0) provides TR1 tuple in a 323 MB +// Feature Pack download, which we cannot assume the user has. +# if (defined(__GNUC__) && !defined(__CUDACC__) && (GTEST_GCC_VER_ >= 40000)) \ + || _MSC_VER >= 1600 +# define GTEST_USE_OWN_TR1_TUPLE 0 +# else +# define GTEST_USE_OWN_TR1_TUPLE 1 +# endif + +#endif // GTEST_USE_OWN_TR1_TUPLE + +// To avoid conditional compilation everywhere, we make it +// gtest-port.h's responsibility to #include the header implementing +// tr1/tuple. +#if GTEST_HAS_TR1_TUPLE + +# if GTEST_USE_OWN_TR1_TUPLE +# include "gtest/internal/gtest-tuple.h" +# elif GTEST_OS_SYMBIAN + +// On Symbian, BOOST_HAS_TR1_TUPLE causes Boost's TR1 tuple library to +// use STLport's tuple implementation, which unfortunately doesn't +// work as the copy of STLport distributed with Symbian is incomplete. +// By making sure BOOST_HAS_TR1_TUPLE is undefined, we force Boost to +// use its own tuple implementation. +# ifdef BOOST_HAS_TR1_TUPLE +# undef BOOST_HAS_TR1_TUPLE +# endif // BOOST_HAS_TR1_TUPLE + +// This prevents , which defines +// BOOST_HAS_TR1_TUPLE, from being #included by Boost's . +# define BOOST_TR1_DETAIL_CONFIG_HPP_INCLUDED +# include + +# elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40000) +// GCC 4.0+ implements tr1/tuple in the header. This does +// not conform to the TR1 spec, which requires the header to be . + +# if !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302 +// Until version 4.3.2, gcc has a bug that causes , +// which is #included by , to not compile when RTTI is +// disabled. _TR1_FUNCTIONAL is the header guard for +// . Hence the following #define is a hack to prevent +// from being included. +# define _TR1_FUNCTIONAL 1 +# include +# undef _TR1_FUNCTIONAL // Allows the user to #include + // if he chooses to. +# else +# include // NOLINT +# endif // !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302 + +# else +// If the compiler is not GCC 4.0+, we assume the user is using a +// spec-conforming TR1 implementation. +# include // NOLINT +# endif // GTEST_USE_OWN_TR1_TUPLE + +#endif // GTEST_HAS_TR1_TUPLE + +// Determines whether clone(2) is supported. +// Usually it will only be available on Linux, excluding +// Linux on the Itanium architecture. +// Also see http://linux.die.net/man/2/clone. +#ifndef GTEST_HAS_CLONE +// The user didn't tell us, so we need to figure it out. + +# if GTEST_OS_LINUX && !defined(__ia64__) +# define GTEST_HAS_CLONE 1 +# else +# define GTEST_HAS_CLONE 0 +# endif // GTEST_OS_LINUX && !defined(__ia64__) + +#endif // GTEST_HAS_CLONE + +// Determines whether to support stream redirection. This is used to test +// output correctness and to implement death tests. +#ifndef GTEST_HAS_STREAM_REDIRECTION +// By default, we assume that stream redirection is supported on all +// platforms except known mobile ones. +# if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN +# define GTEST_HAS_STREAM_REDIRECTION 0 +# else +# define GTEST_HAS_STREAM_REDIRECTION 1 +# endif // !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_SYMBIAN +#endif // GTEST_HAS_STREAM_REDIRECTION + +// Determines whether to support death tests. +// Google Test does not support death tests for VC 7.1 and earlier as +// abort() in a VC 7.1 application compiled as GUI in debug config +// pops up a dialog window that cannot be suppressed programmatically. +#if (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS || \ + (GTEST_OS_WINDOWS_DESKTOP && _MSC_VER >= 1400) || \ + GTEST_OS_WINDOWS_MINGW || GTEST_OS_AIX || GTEST_OS_HPUX) +# define GTEST_HAS_DEATH_TEST 1 +# include // NOLINT +#endif + +// We don't support MSVC 7.1 with exceptions disabled now. Therefore +// all the compilers we care about are adequate for supporting +// value-parameterized tests. +#define GTEST_HAS_PARAM_TEST 1 + +// Determines whether to support type-driven tests. + +// Typed tests need and variadic macros, which GCC, VC++ 8.0, +// Sun Pro CC, IBM Visual Age, and HP aCC support. +#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__SUNPRO_CC) || \ + defined(__IBMCPP__) || defined(__HP_aCC) +# define GTEST_HAS_TYPED_TEST 1 +# define GTEST_HAS_TYPED_TEST_P 1 +#endif + +// Determines whether to support Combine(). This only makes sense when +// value-parameterized tests are enabled. The implementation doesn't +// work on Sun Studio since it doesn't understand templated conversion +// operators. +#if GTEST_HAS_PARAM_TEST && GTEST_HAS_TR1_TUPLE && !defined(__SUNPRO_CC) +# define GTEST_HAS_COMBINE 1 +#endif + +// Determines whether the system compiler uses UTF-16 for encoding wide strings. +#define GTEST_WIDE_STRING_USES_UTF16_ \ + (GTEST_OS_WINDOWS || GTEST_OS_CYGWIN || GTEST_OS_SYMBIAN || GTEST_OS_AIX) + +// Determines whether test results can be streamed to a socket. +#if GTEST_OS_LINUX +# define GTEST_CAN_STREAM_RESULTS_ 1 +#endif + +// Defines some utility macros. + +// The GNU compiler emits a warning if nested "if" statements are followed by +// an "else" statement and braces are not used to explicitly disambiguate the +// "else" binding. This leads to problems with code like: +// +// if (gate) +// ASSERT_*(condition) << "Some message"; +// +// The "switch (0) case 0:" idiom is used to suppress this. +#ifdef __INTEL_COMPILER +# define GTEST_AMBIGUOUS_ELSE_BLOCKER_ +#else +# define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0: default: // NOLINT +#endif + +// Use this annotation at the end of a struct/class definition to +// prevent the compiler from optimizing away instances that are never +// used. This is useful when all interesting logic happens inside the +// c'tor and / or d'tor. Example: +// +// struct Foo { +// Foo() { ... } +// } GTEST_ATTRIBUTE_UNUSED_; +// +// Also use it after a variable or parameter declaration to tell the +// compiler the variable/parameter does not have to be used. +#if defined(__GNUC__) && !defined(COMPILER_ICC) +# define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused)) +#else +# define GTEST_ATTRIBUTE_UNUSED_ +#endif + +// A macro to disallow operator= +// This should be used in the private: declarations for a class. +#define GTEST_DISALLOW_ASSIGN_(type)\ + void operator=(type const &) + +// A macro to disallow copy constructor and operator= +// This should be used in the private: declarations for a class. +#define GTEST_DISALLOW_COPY_AND_ASSIGN_(type)\ + type(type const &);\ + GTEST_DISALLOW_ASSIGN_(type) + +// Tell the compiler to warn about unused return values for functions declared +// with this macro. The macro should be used on function declarations +// following the argument list: +// +// Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_; +#if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC) +# define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result)) +#else +# define GTEST_MUST_USE_RESULT_ +#endif // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC + +// Determine whether the compiler supports Microsoft's Structured Exception +// Handling. This is supported by several Windows compilers but generally +// does not exist on any other system. +#ifndef GTEST_HAS_SEH +// The user didn't tell us, so we need to figure it out. + +# if defined(_MSC_VER) || defined(__BORLANDC__) +// These two compilers are known to support SEH. +# define GTEST_HAS_SEH 1 +# else +// Assume no SEH. +# define GTEST_HAS_SEH 0 +# endif + +#endif // GTEST_HAS_SEH + +#ifdef _MSC_VER + +# if GTEST_LINKED_AS_SHARED_LIBRARY +# define GTEST_API_ __declspec(dllimport) +# elif GTEST_CREATE_SHARED_LIBRARY +# define GTEST_API_ __declspec(dllexport) +# endif + +#endif // _MSC_VER + +#ifndef GTEST_API_ +# define GTEST_API_ +#endif + +#ifdef __GNUC__ +// Ask the compiler to never inline a given function. +# define GTEST_NO_INLINE_ __attribute__((noinline)) +#else +# define GTEST_NO_INLINE_ +#endif + +namespace testing { + +class Message; + +namespace internal { + +class String; + +// The GTEST_COMPILE_ASSERT_ macro can be used to verify that a compile time +// expression is true. For example, you could use it to verify the +// size of a static array: +// +// GTEST_COMPILE_ASSERT_(ARRAYSIZE(content_type_names) == CONTENT_NUM_TYPES, +// content_type_names_incorrect_size); +// +// or to make sure a struct is smaller than a certain size: +// +// GTEST_COMPILE_ASSERT_(sizeof(foo) < 128, foo_too_large); +// +// The second argument to the macro is the name of the variable. If +// the expression is false, most compilers will issue a warning/error +// containing the name of the variable. + +template +struct CompileAssert { +}; + +#define GTEST_COMPILE_ASSERT_(expr, msg) \ + typedef ::testing::internal::CompileAssert<(bool(expr))> \ + msg[bool(expr) ? 1 : -1] + +// Implementation details of GTEST_COMPILE_ASSERT_: +// +// - GTEST_COMPILE_ASSERT_ works by defining an array type that has -1 +// elements (and thus is invalid) when the expression is false. +// +// - The simpler definition +// +// #define GTEST_COMPILE_ASSERT_(expr, msg) typedef char msg[(expr) ? 1 : -1] +// +// does not work, as gcc supports variable-length arrays whose sizes +// are determined at run-time (this is gcc's extension and not part +// of the C++ standard). As a result, gcc fails to reject the +// following code with the simple definition: +// +// int foo; +// GTEST_COMPILE_ASSERT_(foo, msg); // not supposed to compile as foo is +// // not a compile-time constant. +// +// - By using the type CompileAssert<(bool(expr))>, we ensures that +// expr is a compile-time constant. (Template arguments must be +// determined at compile-time.) +// +// - The outter parentheses in CompileAssert<(bool(expr))> are necessary +// to work around a bug in gcc 3.4.4 and 4.0.1. If we had written +// +// CompileAssert +// +// instead, these compilers will refuse to compile +// +// GTEST_COMPILE_ASSERT_(5 > 0, some_message); +// +// (They seem to think the ">" in "5 > 0" marks the end of the +// template argument list.) +// +// - The array size is (bool(expr) ? 1 : -1), instead of simply +// +// ((expr) ? 1 : -1). +// +// This is to avoid running into a bug in MS VC 7.1, which +// causes ((0.0) ? 1 : -1) to incorrectly evaluate to 1. + +// StaticAssertTypeEqHelper is used by StaticAssertTypeEq defined in gtest.h. +// +// This template is declared, but intentionally undefined. +template +struct StaticAssertTypeEqHelper; + +template +struct StaticAssertTypeEqHelper {}; + +#if GTEST_HAS_GLOBAL_STRING +typedef ::string string; +#else +typedef ::std::string string; +#endif // GTEST_HAS_GLOBAL_STRING + +#if GTEST_HAS_GLOBAL_WSTRING +typedef ::wstring wstring; +#elif GTEST_HAS_STD_WSTRING +typedef ::std::wstring wstring; +#endif // GTEST_HAS_GLOBAL_WSTRING + +// A helper for suppressing warnings on constant condition. It just +// returns 'condition'. +GTEST_API_ bool IsTrue(bool condition); + +// Defines scoped_ptr. + +// This implementation of scoped_ptr is PARTIAL - it only contains +// enough stuff to satisfy Google Test's need. +template +class scoped_ptr { + public: + typedef T element_type; + + explicit scoped_ptr(T* p = NULL) : ptr_(p) {} + ~scoped_ptr() { reset(); } + + T& operator*() const { return *ptr_; } + T* operator->() const { return ptr_; } + T* get() const { return ptr_; } + + T* release() { + T* const ptr = ptr_; + ptr_ = NULL; + return ptr; + } + + void reset(T* p = NULL) { + if (p != ptr_) { + if (IsTrue(sizeof(T) > 0)) { // Makes sure T is a complete type. + delete ptr_; + } + ptr_ = p; + } + } + private: + T* ptr_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(scoped_ptr); +}; + +// Defines RE. + +// A simple C++ wrapper for . It uses the POSIX Extended +// Regular Expression syntax. +class GTEST_API_ RE { + public: + // A copy constructor is required by the Standard to initialize object + // references from r-values. + RE(const RE& other) { Init(other.pattern()); } + + // Constructs an RE from a string. + RE(const ::std::string& regex) { Init(regex.c_str()); } // NOLINT + +#if GTEST_HAS_GLOBAL_STRING + + RE(const ::string& regex) { Init(regex.c_str()); } // NOLINT + +#endif // GTEST_HAS_GLOBAL_STRING + + RE(const char* regex) { Init(regex); } // NOLINT + ~RE(); + + // Returns the string representation of the regex. + const char* pattern() const { return pattern_; } + + // FullMatch(str, re) returns true iff regular expression re matches + // the entire str. + // PartialMatch(str, re) returns true iff regular expression re + // matches a substring of str (including str itself). + // + // TODO(wan@google.com): make FullMatch() and PartialMatch() work + // when str contains NUL characters. + static bool FullMatch(const ::std::string& str, const RE& re) { + return FullMatch(str.c_str(), re); + } + static bool PartialMatch(const ::std::string& str, const RE& re) { + return PartialMatch(str.c_str(), re); + } + +#if GTEST_HAS_GLOBAL_STRING + + static bool FullMatch(const ::string& str, const RE& re) { + return FullMatch(str.c_str(), re); + } + static bool PartialMatch(const ::string& str, const RE& re) { + return PartialMatch(str.c_str(), re); + } + +#endif // GTEST_HAS_GLOBAL_STRING + + static bool FullMatch(const char* str, const RE& re); + static bool PartialMatch(const char* str, const RE& re); + + private: + void Init(const char* regex); + + // We use a const char* instead of a string, as Google Test may be used + // where string is not available. We also do not use Google Test's own + // String type here, in order to simplify dependencies between the + // files. + const char* pattern_; + bool is_valid_; + +#if GTEST_USES_POSIX_RE + + regex_t full_regex_; // For FullMatch(). + regex_t partial_regex_; // For PartialMatch(). + +#else // GTEST_USES_SIMPLE_RE + + const char* full_pattern_; // For FullMatch(); + +#endif + + GTEST_DISALLOW_ASSIGN_(RE); +}; + +// Formats a source file path and a line number as they would appear +// in an error message from the compiler used to compile this code. +GTEST_API_ ::std::string FormatFileLocation(const char* file, int line); + +// Formats a file location for compiler-independent XML output. +// Although this function is not platform dependent, we put it next to +// FormatFileLocation in order to contrast the two functions. +GTEST_API_ ::std::string FormatCompilerIndependentFileLocation(const char* file, + int line); + +// Defines logging utilities: +// GTEST_LOG_(severity) - logs messages at the specified severity level. The +// message itself is streamed into the macro. +// LogToStderr() - directs all log messages to stderr. +// FlushInfoLog() - flushes informational log messages. + +enum GTestLogSeverity { + GTEST_INFO, + GTEST_WARNING, + GTEST_ERROR, + GTEST_FATAL +}; + +// Formats log entry severity, provides a stream object for streaming the +// log message, and terminates the message with a newline when going out of +// scope. +class GTEST_API_ GTestLog { + public: + GTestLog(GTestLogSeverity severity, const char* file, int line); + + // Flushes the buffers and, if severity is GTEST_FATAL, aborts the program. + ~GTestLog(); + + ::std::ostream& GetStream() { return ::std::cerr; } + + private: + const GTestLogSeverity severity_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestLog); +}; + +#define GTEST_LOG_(severity) \ + ::testing::internal::GTestLog(::testing::internal::GTEST_##severity, \ + __FILE__, __LINE__).GetStream() + +inline void LogToStderr() {} +inline void FlushInfoLog() { fflush(NULL); } + +// INTERNAL IMPLEMENTATION - DO NOT USE. +// +// GTEST_CHECK_ is an all-mode assert. It aborts the program if the condition +// is not satisfied. +// Synopsys: +// GTEST_CHECK_(boolean_condition); +// or +// GTEST_CHECK_(boolean_condition) << "Additional message"; +// +// This checks the condition and if the condition is not satisfied +// it prints message about the condition violation, including the +// condition itself, plus additional message streamed into it, if any, +// and then it aborts the program. It aborts the program irrespective of +// whether it is built in the debug mode or not. +#define GTEST_CHECK_(condition) \ + GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ + if (::testing::internal::IsTrue(condition)) \ + ; \ + else \ + GTEST_LOG_(FATAL) << "Condition " #condition " failed. " + +// An all-mode assert to verify that the given POSIX-style function +// call returns 0 (indicating success). Known limitation: this +// doesn't expand to a balanced 'if' statement, so enclose the macro +// in {} if you need to use it as the only statement in an 'if' +// branch. +#define GTEST_CHECK_POSIX_SUCCESS_(posix_call) \ + if (const int gtest_error = (posix_call)) \ + GTEST_LOG_(FATAL) << #posix_call << "failed with error " \ + << gtest_error + +// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. +// +// Use ImplicitCast_ as a safe version of static_cast for upcasting in +// the type hierarchy (e.g. casting a Foo* to a SuperclassOfFoo* or a +// const Foo*). When you use ImplicitCast_, the compiler checks that +// the cast is safe. Such explicit ImplicitCast_s are necessary in +// surprisingly many situations where C++ demands an exact type match +// instead of an argument type convertable to a target type. +// +// The syntax for using ImplicitCast_ is the same as for static_cast: +// +// ImplicitCast_(expr) +// +// ImplicitCast_ would have been part of the C++ standard library, +// but the proposal was submitted too late. It will probably make +// its way into the language in the future. +// +// This relatively ugly name is intentional. It prevents clashes with +// similar functions users may have (e.g., implicit_cast). The internal +// namespace alone is not enough because the function can be found by ADL. +template +inline To ImplicitCast_(To x) { return x; } + +// When you upcast (that is, cast a pointer from type Foo to type +// SuperclassOfFoo), it's fine to use ImplicitCast_<>, since upcasts +// always succeed. When you downcast (that is, cast a pointer from +// type Foo to type SubclassOfFoo), static_cast<> isn't safe, because +// how do you know the pointer is really of type SubclassOfFoo? It +// could be a bare Foo, or of type DifferentSubclassOfFoo. Thus, +// when you downcast, you should use this macro. In debug mode, we +// use dynamic_cast<> to double-check the downcast is legal (we die +// if it's not). In normal mode, we do the efficient static_cast<> +// instead. Thus, it's important to test in debug mode to make sure +// the cast is legal! +// This is the only place in the code we should use dynamic_cast<>. +// In particular, you SHOULDN'T be using dynamic_cast<> in order to +// do RTTI (eg code like this: +// if (dynamic_cast(foo)) HandleASubclass1Object(foo); +// if (dynamic_cast(foo)) HandleASubclass2Object(foo); +// You should design the code some other way not to need this. +// +// This relatively ugly name is intentional. It prevents clashes with +// similar functions users may have (e.g., down_cast). The internal +// namespace alone is not enough because the function can be found by ADL. +template // use like this: DownCast_(foo); +inline To DownCast_(From* f) { // so we only accept pointers + // Ensures that To is a sub-type of From *. This test is here only + // for compile-time type checking, and has no overhead in an + // optimized build at run-time, as it will be optimized away + // completely. + if (false) { + const To to = NULL; + ::testing::internal::ImplicitCast_(to); + } + +#if GTEST_HAS_RTTI + // RTTI: debug mode only! + GTEST_CHECK_(f == NULL || dynamic_cast(f) != NULL); +#endif + return static_cast(f); +} + +// Downcasts the pointer of type Base to Derived. +// Derived must be a subclass of Base. The parameter MUST +// point to a class of type Derived, not any subclass of it. +// When RTTI is available, the function performs a runtime +// check to enforce this. +template +Derived* CheckedDowncastToActualType(Base* base) { +#if GTEST_HAS_RTTI + GTEST_CHECK_(typeid(*base) == typeid(Derived)); + return dynamic_cast(base); // NOLINT +#else + return static_cast(base); // Poor man's downcast. +#endif +} + +#if GTEST_HAS_STREAM_REDIRECTION + +// Defines the stderr capturer: +// CaptureStdout - starts capturing stdout. +// GetCapturedStdout - stops capturing stdout and returns the captured string. +// CaptureStderr - starts capturing stderr. +// GetCapturedStderr - stops capturing stderr and returns the captured string. +// +GTEST_API_ void CaptureStdout(); +GTEST_API_ String GetCapturedStdout(); +GTEST_API_ void CaptureStderr(); +GTEST_API_ String GetCapturedStderr(); + +#endif // GTEST_HAS_STREAM_REDIRECTION + + +#if GTEST_HAS_DEATH_TEST + +// A copy of all command line arguments. Set by InitGoogleTest(). +extern ::std::vector g_argvs; + +// GTEST_HAS_DEATH_TEST implies we have ::std::string. +const ::std::vector& GetArgvs(); + +#endif // GTEST_HAS_DEATH_TEST + +// Defines synchronization primitives. + +#if GTEST_HAS_PTHREAD + +// Sleeps for (roughly) n milli-seconds. This function is only for +// testing Google Test's own constructs. Don't use it in user tests, +// either directly or indirectly. +inline void SleepMilliseconds(int n) { + const timespec time = { + 0, // 0 seconds. + n * 1000L * 1000L, // And n ms. + }; + nanosleep(&time, NULL); +} + +// Allows a controller thread to pause execution of newly created +// threads until notified. Instances of this class must be created +// and destroyed in the controller thread. +// +// This class is only for testing Google Test's own constructs. Do not +// use it in user tests, either directly or indirectly. +class Notification { + public: + Notification() : notified_(false) {} + + // Notifies all threads created with this notification to start. Must + // be called from the controller thread. + void Notify() { notified_ = true; } + + // Blocks until the controller thread notifies. Must be called from a test + // thread. + void WaitForNotification() { + while(!notified_) { + SleepMilliseconds(10); + } + } + + private: + volatile bool notified_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification); +}; + +// As a C-function, ThreadFuncWithCLinkage cannot be templated itself. +// Consequently, it cannot select a correct instantiation of ThreadWithParam +// in order to call its Run(). Introducing ThreadWithParamBase as a +// non-templated base class for ThreadWithParam allows us to bypass this +// problem. +class ThreadWithParamBase { + public: + virtual ~ThreadWithParamBase() {} + virtual void Run() = 0; +}; + +// pthread_create() accepts a pointer to a function type with the C linkage. +// According to the Standard (7.5/1), function types with different linkages +// are different even if they are otherwise identical. Some compilers (for +// example, SunStudio) treat them as different types. Since class methods +// cannot be defined with C-linkage we need to define a free C-function to +// pass into pthread_create(). +extern "C" inline void* ThreadFuncWithCLinkage(void* thread) { + static_cast(thread)->Run(); + return NULL; +} + +// Helper class for testing Google Test's multi-threading constructs. +// To use it, write: +// +// void ThreadFunc(int param) { /* Do things with param */ } +// Notification thread_can_start; +// ... +// // The thread_can_start parameter is optional; you can supply NULL. +// ThreadWithParam thread(&ThreadFunc, 5, &thread_can_start); +// thread_can_start.Notify(); +// +// These classes are only for testing Google Test's own constructs. Do +// not use them in user tests, either directly or indirectly. +template +class ThreadWithParam : public ThreadWithParamBase { + public: + typedef void (*UserThreadFunc)(T); + + ThreadWithParam( + UserThreadFunc func, T param, Notification* thread_can_start) + : func_(func), + param_(param), + thread_can_start_(thread_can_start), + finished_(false) { + ThreadWithParamBase* const base = this; + // The thread can be created only after all fields except thread_ + // have been initialized. + GTEST_CHECK_POSIX_SUCCESS_( + pthread_create(&thread_, 0, &ThreadFuncWithCLinkage, base)); + } + ~ThreadWithParam() { Join(); } + + void Join() { + if (!finished_) { + GTEST_CHECK_POSIX_SUCCESS_(pthread_join(thread_, 0)); + finished_ = true; + } + } + + virtual void Run() { + if (thread_can_start_ != NULL) + thread_can_start_->WaitForNotification(); + func_(param_); + } + + private: + const UserThreadFunc func_; // User-supplied thread function. + const T param_; // User-supplied parameter to the thread function. + // When non-NULL, used to block execution until the controller thread + // notifies. + Notification* const thread_can_start_; + bool finished_; // true iff we know that the thread function has finished. + pthread_t thread_; // The native thread object. + + GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam); +}; + +// MutexBase and Mutex implement mutex on pthreads-based platforms. They +// are used in conjunction with class MutexLock: +// +// Mutex mutex; +// ... +// MutexLock lock(&mutex); // Acquires the mutex and releases it at the end +// // of the current scope. +// +// MutexBase implements behavior for both statically and dynamically +// allocated mutexes. Do not use MutexBase directly. Instead, write +// the following to define a static mutex: +// +// GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex); +// +// You can forward declare a static mutex like this: +// +// GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex); +// +// To create a dynamic mutex, just define an object of type Mutex. +class MutexBase { + public: + // Acquires this mutex. + void Lock() { + GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_lock(&mutex_)); + owner_ = pthread_self(); + } + + // Releases this mutex. + void Unlock() { + // We don't protect writing to owner_ here, as it's the caller's + // responsibility to ensure that the current thread holds the + // mutex when this is called. + owner_ = 0; + GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_unlock(&mutex_)); + } + + // Does nothing if the current thread holds the mutex. Otherwise, crashes + // with high probability. + void AssertHeld() const { + GTEST_CHECK_(owner_ == pthread_self()) + << "The current thread is not holding the mutex @" << this; + } + + // A static mutex may be used before main() is entered. It may even + // be used before the dynamic initialization stage. Therefore we + // must be able to initialize a static mutex object at link time. + // This means MutexBase has to be a POD and its member variables + // have to be public. + public: + pthread_mutex_t mutex_; // The underlying pthread mutex. + pthread_t owner_; // The thread holding the mutex; 0 means no one holds it. +}; + +// Forward-declares a static mutex. +# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \ + extern ::testing::internal::MutexBase mutex + +// Defines and statically (i.e. at link time) initializes a static mutex. +# define GTEST_DEFINE_STATIC_MUTEX_(mutex) \ + ::testing::internal::MutexBase mutex = { PTHREAD_MUTEX_INITIALIZER, 0 } + +// The Mutex class can only be used for mutexes created at runtime. It +// shares its API with MutexBase otherwise. +class Mutex : public MutexBase { + public: + Mutex() { + GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL)); + owner_ = 0; + } + ~Mutex() { + GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_destroy(&mutex_)); + } + + private: + GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex); +}; + +// We cannot name this class MutexLock as the ctor declaration would +// conflict with a macro named MutexLock, which is defined on some +// platforms. Hence the typedef trick below. +class GTestMutexLock { + public: + explicit GTestMutexLock(MutexBase* mutex) + : mutex_(mutex) { mutex_->Lock(); } + + ~GTestMutexLock() { mutex_->Unlock(); } + + private: + MutexBase* const mutex_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestMutexLock); +}; + +typedef GTestMutexLock MutexLock; + +// Helpers for ThreadLocal. + +// pthread_key_create() requires DeleteThreadLocalValue() to have +// C-linkage. Therefore it cannot be templatized to access +// ThreadLocal. Hence the need for class +// ThreadLocalValueHolderBase. +class ThreadLocalValueHolderBase { + public: + virtual ~ThreadLocalValueHolderBase() {} +}; + +// Called by pthread to delete thread-local data stored by +// pthread_setspecific(). +extern "C" inline void DeleteThreadLocalValue(void* value_holder) { + delete static_cast(value_holder); +} + +// Implements thread-local storage on pthreads-based systems. +// +// // Thread 1 +// ThreadLocal tl(100); // 100 is the default value for each thread. +// +// // Thread 2 +// tl.set(150); // Changes the value for thread 2 only. +// EXPECT_EQ(150, tl.get()); +// +// // Thread 1 +// EXPECT_EQ(100, tl.get()); // In thread 1, tl has the original value. +// tl.set(200); +// EXPECT_EQ(200, tl.get()); +// +// The template type argument T must have a public copy constructor. +// In addition, the default ThreadLocal constructor requires T to have +// a public default constructor. +// +// An object managed for a thread by a ThreadLocal instance is deleted +// when the thread exits. Or, if the ThreadLocal instance dies in +// that thread, when the ThreadLocal dies. It's the user's +// responsibility to ensure that all other threads using a ThreadLocal +// have exited when it dies, or the per-thread objects for those +// threads will not be deleted. +// +// Google Test only uses global ThreadLocal objects. That means they +// will die after main() has returned. Therefore, no per-thread +// object managed by Google Test will be leaked as long as all threads +// using Google Test have exited when main() returns. +template +class ThreadLocal { + public: + ThreadLocal() : key_(CreateKey()), + default_() {} + explicit ThreadLocal(const T& value) : key_(CreateKey()), + default_(value) {} + + ~ThreadLocal() { + // Destroys the managed object for the current thread, if any. + DeleteThreadLocalValue(pthread_getspecific(key_)); + + // Releases resources associated with the key. This will *not* + // delete managed objects for other threads. + GTEST_CHECK_POSIX_SUCCESS_(pthread_key_delete(key_)); + } + + T* pointer() { return GetOrCreateValue(); } + const T* pointer() const { return GetOrCreateValue(); } + const T& get() const { return *pointer(); } + void set(const T& value) { *pointer() = value; } + + private: + // Holds a value of type T. + class ValueHolder : public ThreadLocalValueHolderBase { + public: + explicit ValueHolder(const T& value) : value_(value) {} + + T* pointer() { return &value_; } + + private: + T value_; + GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolder); + }; + + static pthread_key_t CreateKey() { + pthread_key_t key; + // When a thread exits, DeleteThreadLocalValue() will be called on + // the object managed for that thread. + GTEST_CHECK_POSIX_SUCCESS_( + pthread_key_create(&key, &DeleteThreadLocalValue)); + return key; + } + + T* GetOrCreateValue() const { + ThreadLocalValueHolderBase* const holder = + static_cast(pthread_getspecific(key_)); + if (holder != NULL) { + return CheckedDowncastToActualType(holder)->pointer(); + } + + ValueHolder* const new_holder = new ValueHolder(default_); + ThreadLocalValueHolderBase* const holder_base = new_holder; + GTEST_CHECK_POSIX_SUCCESS_(pthread_setspecific(key_, holder_base)); + return new_holder->pointer(); + } + + // A key pthreads uses for looking up per-thread values. + const pthread_key_t key_; + const T default_; // The default value for each thread. + + GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal); +}; + +# define GTEST_IS_THREADSAFE 1 + +#else // GTEST_HAS_PTHREAD + +// A dummy implementation of synchronization primitives (mutex, lock, +// and thread-local variable). Necessary for compiling Google Test where +// mutex is not supported - using Google Test in multiple threads is not +// supported on such platforms. + +class Mutex { + public: + Mutex() {} + void AssertHeld() const {} +}; + +# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \ + extern ::testing::internal::Mutex mutex + +# define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex + +class GTestMutexLock { + public: + explicit GTestMutexLock(Mutex*) {} // NOLINT +}; + +typedef GTestMutexLock MutexLock; + +template +class ThreadLocal { + public: + ThreadLocal() : value_() {} + explicit ThreadLocal(const T& value) : value_(value) {} + T* pointer() { return &value_; } + const T* pointer() const { return &value_; } + const T& get() const { return value_; } + void set(const T& value) { value_ = value; } + private: + T value_; +}; + +// The above synchronization primitives have dummy implementations. +// Therefore Google Test is not thread-safe. +# define GTEST_IS_THREADSAFE 0 + +#endif // GTEST_HAS_PTHREAD + +// Returns the number of threads running in the process, or 0 to indicate that +// we cannot detect it. +GTEST_API_ size_t GetThreadCount(); + +// Passing non-POD classes through ellipsis (...) crashes the ARM +// compiler and generates a warning in Sun Studio. The Nokia Symbian +// and the IBM XL C/C++ compiler try to instantiate a copy constructor +// for objects passed through ellipsis (...), failing for uncopyable +// objects. We define this to ensure that only POD is passed through +// ellipsis on these systems. +#if defined(__SYMBIAN32__) || defined(__IBMCPP__) || defined(__SUNPRO_CC) +// We lose support for NULL detection where the compiler doesn't like +// passing non-POD classes through ellipsis (...). +# define GTEST_ELLIPSIS_NEEDS_POD_ 1 +#else +# define GTEST_CAN_COMPARE_NULL 1 +#endif + +// The Nokia Symbian and IBM XL C/C++ compilers cannot decide between +// const T& and const T* in a function template. These compilers +// _can_ decide between class template specializations for T and T*, +// so a tr1::type_traits-like is_pointer works. +#if defined(__SYMBIAN32__) || defined(__IBMCPP__) +# define GTEST_NEEDS_IS_POINTER_ 1 +#endif + +template +struct bool_constant { + typedef bool_constant type; + static const bool value = bool_value; +}; +template const bool bool_constant::value; + +typedef bool_constant false_type; +typedef bool_constant true_type; + +template +struct is_pointer : public false_type {}; + +template +struct is_pointer : public true_type {}; + +template +struct IteratorTraits { + typedef typename Iterator::value_type value_type; +}; + +template +struct IteratorTraits { + typedef T value_type; +}; + +template +struct IteratorTraits { + typedef T value_type; +}; + +#if GTEST_OS_WINDOWS +# define GTEST_PATH_SEP_ "\\" +# define GTEST_HAS_ALT_PATH_SEP_ 1 +// The biggest signed integer type the compiler supports. +typedef __int64 BiggestInt; +#else +# define GTEST_PATH_SEP_ "/" +# define GTEST_HAS_ALT_PATH_SEP_ 0 +typedef long long BiggestInt; // NOLINT +#endif // GTEST_OS_WINDOWS + +// Utilities for char. + +// isspace(int ch) and friends accept an unsigned char or EOF. char +// may be signed, depending on the compiler (or compiler flags). +// Therefore we need to cast a char to unsigned char before calling +// isspace(), etc. + +inline bool IsAlpha(char ch) { + return isalpha(static_cast(ch)) != 0; +} +inline bool IsAlNum(char ch) { + return isalnum(static_cast(ch)) != 0; +} +inline bool IsDigit(char ch) { + return isdigit(static_cast(ch)) != 0; +} +inline bool IsLower(char ch) { + return islower(static_cast(ch)) != 0; +} +inline bool IsSpace(char ch) { + return isspace(static_cast(ch)) != 0; +} +inline bool IsUpper(char ch) { + return isupper(static_cast(ch)) != 0; +} +inline bool IsXDigit(char ch) { + return isxdigit(static_cast(ch)) != 0; +} + +inline char ToLower(char ch) { + return static_cast(tolower(static_cast(ch))); +} +inline char ToUpper(char ch) { + return static_cast(toupper(static_cast(ch))); +} + +// The testing::internal::posix namespace holds wrappers for common +// POSIX functions. These wrappers hide the differences between +// Windows/MSVC and POSIX systems. Since some compilers define these +// standard functions as macros, the wrapper cannot have the same name +// as the wrapped function. + +namespace posix { + +// Functions with a different name on Windows. + +#if GTEST_OS_WINDOWS + +typedef struct _stat StatStruct; + +# ifdef __BORLANDC__ +inline int IsATTY(int fd) { return isatty(fd); } +inline int StrCaseCmp(const char* s1, const char* s2) { + return stricmp(s1, s2); +} +inline char* StrDup(const char* src) { return strdup(src); } +# else // !__BORLANDC__ +# if GTEST_OS_WINDOWS_MOBILE +inline int IsATTY(int /* fd */) { return 0; } +# else +inline int IsATTY(int fd) { return _isatty(fd); } +# endif // GTEST_OS_WINDOWS_MOBILE +inline int StrCaseCmp(const char* s1, const char* s2) { + return _stricmp(s1, s2); +} +inline char* StrDup(const char* src) { return _strdup(src); } +# endif // __BORLANDC__ + +# if GTEST_OS_WINDOWS_MOBILE +inline int FileNo(FILE* file) { return reinterpret_cast(_fileno(file)); } +// Stat(), RmDir(), and IsDir() are not needed on Windows CE at this +// time and thus not defined there. +# else +inline int FileNo(FILE* file) { return _fileno(file); } +inline int Stat(const char* path, StatStruct* buf) { return _stat(path, buf); } +inline int RmDir(const char* dir) { return _rmdir(dir); } +inline bool IsDir(const StatStruct& st) { + return (_S_IFDIR & st.st_mode) != 0; +} +# endif // GTEST_OS_WINDOWS_MOBILE + +#else + +typedef struct stat StatStruct; + +inline int FileNo(FILE* file) { return fileno(file); } +inline int IsATTY(int fd) { return isatty(fd); } +inline int Stat(const char* path, StatStruct* buf) { return stat(path, buf); } +inline int StrCaseCmp(const char* s1, const char* s2) { + return strcasecmp(s1, s2); +} +inline char* StrDup(const char* src) { return strdup(src); } +inline int RmDir(const char* dir) { return rmdir(dir); } +inline bool IsDir(const StatStruct& st) { return S_ISDIR(st.st_mode); } + +#endif // GTEST_OS_WINDOWS + +// Functions deprecated by MSVC 8.0. + +#ifdef _MSC_VER +// Temporarily disable warning 4996 (deprecated function). +# pragma warning(push) +# pragma warning(disable:4996) +#endif + +inline const char* StrNCpy(char* dest, const char* src, size_t n) { + return strncpy(dest, src, n); +} + +// ChDir(), FReopen(), FDOpen(), Read(), Write(), Close(), and +// StrError() aren't needed on Windows CE at this time and thus not +// defined there. + +#if !GTEST_OS_WINDOWS_MOBILE +inline int ChDir(const char* dir) { return chdir(dir); } +#endif +inline FILE* FOpen(const char* path, const char* mode) { + return fopen(path, mode); +} +#if !GTEST_OS_WINDOWS_MOBILE +inline FILE *FReopen(const char* path, const char* mode, FILE* stream) { + return freopen(path, mode, stream); +} +inline FILE* FDOpen(int fd, const char* mode) { return fdopen(fd, mode); } +#endif +inline int FClose(FILE* fp) { return fclose(fp); } +#if !GTEST_OS_WINDOWS_MOBILE +inline int Read(int fd, void* buf, unsigned int count) { + return static_cast(read(fd, buf, count)); +} +inline int Write(int fd, const void* buf, unsigned int count) { + return static_cast(write(fd, buf, count)); +} +inline int Close(int fd) { return close(fd); } +inline const char* StrError(int errnum) { return strerror(errnum); } +#endif +inline const char* GetEnv(const char* name) { +#if GTEST_OS_WINDOWS_MOBILE + // We are on Windows CE, which has no environment variables. + return NULL; +#elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9) + // Environment variables which we programmatically clear will be set to the + // empty string rather than unset (NULL). Handle that case. + const char* const env = getenv(name); + return (env != NULL && env[0] != '\0') ? env : NULL; +#else + return getenv(name); +#endif +} + +#ifdef _MSC_VER +# pragma warning(pop) // Restores the warning state. +#endif + +#if GTEST_OS_WINDOWS_MOBILE +// Windows CE has no C library. The abort() function is used in +// several places in Google Test. This implementation provides a reasonable +// imitation of standard behaviour. +void Abort(); +#else +inline void Abort() { abort(); } +#endif // GTEST_OS_WINDOWS_MOBILE + +} // namespace posix + +// The maximum number a BiggestInt can represent. This definition +// works no matter BiggestInt is represented in one's complement or +// two's complement. +// +// We cannot rely on numeric_limits in STL, as __int64 and long long +// are not part of standard C++ and numeric_limits doesn't need to be +// defined for them. +const BiggestInt kMaxBiggestInt = + ~(static_cast(1) << (8*sizeof(BiggestInt) - 1)); + +// This template class serves as a compile-time function from size to +// type. It maps a size in bytes to a primitive type with that +// size. e.g. +// +// TypeWithSize<4>::UInt +// +// is typedef-ed to be unsigned int (unsigned integer made up of 4 +// bytes). +// +// Such functionality should belong to STL, but I cannot find it +// there. +// +// Google Test uses this class in the implementation of floating-point +// comparison. +// +// For now it only handles UInt (unsigned int) as that's all Google Test +// needs. Other types can be easily added in the future if need +// arises. +template +class TypeWithSize { + public: + // This prevents the user from using TypeWithSize with incorrect + // values of N. + typedef void UInt; +}; + +// The specialization for size 4. +template <> +class TypeWithSize<4> { + public: + // unsigned int has size 4 in both gcc and MSVC. + // + // As base/basictypes.h doesn't compile on Windows, we cannot use + // uint32, uint64, and etc here. + typedef int Int; + typedef unsigned int UInt; +}; + +// The specialization for size 8. +template <> +class TypeWithSize<8> { + public: + +#if GTEST_OS_WINDOWS + typedef __int64 Int; + typedef unsigned __int64 UInt; +#else + typedef long long Int; // NOLINT + typedef unsigned long long UInt; // NOLINT +#endif // GTEST_OS_WINDOWS +}; + +// Integer types of known sizes. +typedef TypeWithSize<4>::Int Int32; +typedef TypeWithSize<4>::UInt UInt32; +typedef TypeWithSize<8>::Int Int64; +typedef TypeWithSize<8>::UInt UInt64; +typedef TypeWithSize<8>::Int TimeInMillis; // Represents time in milliseconds. + +// Utilities for command line flags and environment variables. + +// Macro for referencing flags. +#define GTEST_FLAG(name) FLAGS_gtest_##name + +// Macros for declaring flags. +#define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name) +#define GTEST_DECLARE_int32_(name) \ + GTEST_API_ extern ::testing::internal::Int32 GTEST_FLAG(name) +#define GTEST_DECLARE_string_(name) \ + GTEST_API_ extern ::testing::internal::String GTEST_FLAG(name) + +// Macros for defining flags. +#define GTEST_DEFINE_bool_(name, default_val, doc) \ + GTEST_API_ bool GTEST_FLAG(name) = (default_val) +#define GTEST_DEFINE_int32_(name, default_val, doc) \ + GTEST_API_ ::testing::internal::Int32 GTEST_FLAG(name) = (default_val) +#define GTEST_DEFINE_string_(name, default_val, doc) \ + GTEST_API_ ::testing::internal::String GTEST_FLAG(name) = (default_val) + +// Parses 'str' for a 32-bit signed integer. If successful, writes the result +// to *value and returns true; otherwise leaves *value unchanged and returns +// false. +// TODO(chandlerc): Find a better way to refactor flag and environment parsing +// out of both gtest-port.cc and gtest.cc to avoid exporting this utility +// function. +bool ParseInt32(const Message& src_text, const char* str, Int32* value); + +// Parses a bool/Int32/string from the environment variable +// corresponding to the given Google Test flag. +bool BoolFromGTestEnv(const char* flag, bool default_val); +GTEST_API_ Int32 Int32FromGTestEnv(const char* flag, Int32 default_val); +const char* StringFromGTestEnv(const char* flag, const char* default_val); + +} // namespace internal +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-string.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-string.h new file mode 100644 index 0000000000..e7f385bfef --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-string.h @@ -0,0 +1,350 @@ +// Copyright 2005, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Authors: wan@google.com (Zhanyong Wan), eefacm@gmail.com (Sean Mcafee) +// +// The Google C++ Testing Framework (Google Test) +// +// This header file declares the String class and functions used internally by +// Google Test. They are subject to change without notice. They should not used +// by code external to Google Test. +// +// This header file is #included by . +// It should not be #included by other files. + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ + +#ifdef __BORLANDC__ +// string.h is not guaranteed to provide strcpy on C++ Builder. +# include +#endif + +#include +#include "gtest/internal/gtest-port.h" + +#include + +namespace testing { +namespace internal { + +// String - a UTF-8 string class. +// +// For historic reasons, we don't use std::string. +// +// TODO(wan@google.com): replace this class with std::string or +// implement it in terms of the latter. +// +// Note that String can represent both NULL and the empty string, +// while std::string cannot represent NULL. +// +// NULL and the empty string are considered different. NULL is less +// than anything (including the empty string) except itself. +// +// This class only provides minimum functionality necessary for +// implementing Google Test. We do not intend to implement a full-fledged +// string class here. +// +// Since the purpose of this class is to provide a substitute for +// std::string on platforms where it cannot be used, we define a copy +// constructor and assignment operators such that we don't need +// conditional compilation in a lot of places. +// +// In order to make the representation efficient, the d'tor of String +// is not virtual. Therefore DO NOT INHERIT FROM String. +class GTEST_API_ String { + public: + // Static utility methods + + // Returns the input enclosed in double quotes if it's not NULL; + // otherwise returns "(null)". For example, "\"Hello\"" is returned + // for input "Hello". + // + // This is useful for printing a C string in the syntax of a literal. + // + // Known issue: escape sequences are not handled yet. + static String ShowCStringQuoted(const char* c_str); + + // Clones a 0-terminated C string, allocating memory using new. The + // caller is responsible for deleting the return value using + // delete[]. Returns the cloned string, or NULL if the input is + // NULL. + // + // This is different from strdup() in string.h, which allocates + // memory using malloc(). + static const char* CloneCString(const char* c_str); + +#if GTEST_OS_WINDOWS_MOBILE + // Windows CE does not have the 'ANSI' versions of Win32 APIs. To be + // able to pass strings to Win32 APIs on CE we need to convert them + // to 'Unicode', UTF-16. + + // Creates a UTF-16 wide string from the given ANSI string, allocating + // memory using new. The caller is responsible for deleting the return + // value using delete[]. Returns the wide string, or NULL if the + // input is NULL. + // + // The wide string is created using the ANSI codepage (CP_ACP) to + // match the behaviour of the ANSI versions of Win32 calls and the + // C runtime. + static LPCWSTR AnsiToUtf16(const char* c_str); + + // Creates an ANSI string from the given wide string, allocating + // memory using new. The caller is responsible for deleting the return + // value using delete[]. Returns the ANSI string, or NULL if the + // input is NULL. + // + // The returned string is created using the ANSI codepage (CP_ACP) to + // match the behaviour of the ANSI versions of Win32 calls and the + // C runtime. + static const char* Utf16ToAnsi(LPCWSTR utf16_str); +#endif + + // Compares two C strings. Returns true iff they have the same content. + // + // Unlike strcmp(), this function can handle NULL argument(s). A + // NULL C string is considered different to any non-NULL C string, + // including the empty string. + static bool CStringEquals(const char* lhs, const char* rhs); + + // Converts a wide C string to a String using the UTF-8 encoding. + // NULL will be converted to "(null)". If an error occurred during + // the conversion, "(failed to convert from wide string)" is + // returned. + static String ShowWideCString(const wchar_t* wide_c_str); + + // Similar to ShowWideCString(), except that this function encloses + // the converted string in double quotes. + static String ShowWideCStringQuoted(const wchar_t* wide_c_str); + + // Compares two wide C strings. Returns true iff they have the same + // content. + // + // Unlike wcscmp(), this function can handle NULL argument(s). A + // NULL C string is considered different to any non-NULL C string, + // including the empty string. + static bool WideCStringEquals(const wchar_t* lhs, const wchar_t* rhs); + + // Compares two C strings, ignoring case. Returns true iff they + // have the same content. + // + // Unlike strcasecmp(), this function can handle NULL argument(s). + // A NULL C string is considered different to any non-NULL C string, + // including the empty string. + static bool CaseInsensitiveCStringEquals(const char* lhs, + const char* rhs); + + // Compares two wide C strings, ignoring case. Returns true iff they + // have the same content. + // + // Unlike wcscasecmp(), this function can handle NULL argument(s). + // A NULL C string is considered different to any non-NULL wide C string, + // including the empty string. + // NB: The implementations on different platforms slightly differ. + // On windows, this method uses _wcsicmp which compares according to LC_CTYPE + // environment variable. On GNU platform this method uses wcscasecmp + // which compares according to LC_CTYPE category of the current locale. + // On MacOS X, it uses towlower, which also uses LC_CTYPE category of the + // current locale. + static bool CaseInsensitiveWideCStringEquals(const wchar_t* lhs, + const wchar_t* rhs); + + // Formats a list of arguments to a String, using the same format + // spec string as for printf. + // + // We do not use the StringPrintf class as it is not universally + // available. + // + // The result is limited to 4096 characters (including the tailing + // 0). If 4096 characters are not enough to format the input, + // "" is returned. + static String Format(const char* format, ...); + + // C'tors + + // The default c'tor constructs a NULL string. + String() : c_str_(NULL), length_(0) {} + + // Constructs a String by cloning a 0-terminated C string. + String(const char* a_c_str) { // NOLINT + if (a_c_str == NULL) { + c_str_ = NULL; + length_ = 0; + } else { + ConstructNonNull(a_c_str, strlen(a_c_str)); + } + } + + // Constructs a String by copying a given number of chars from a + // buffer. E.g. String("hello", 3) creates the string "hel", + // String("a\0bcd", 4) creates "a\0bc", String(NULL, 0) creates "", + // and String(NULL, 1) results in access violation. + String(const char* buffer, size_t a_length) { + ConstructNonNull(buffer, a_length); + } + + // The copy c'tor creates a new copy of the string. The two + // String objects do not share content. + String(const String& str) : c_str_(NULL), length_(0) { *this = str; } + + // D'tor. String is intended to be a final class, so the d'tor + // doesn't need to be virtual. + ~String() { delete[] c_str_; } + + // Allows a String to be implicitly converted to an ::std::string or + // ::string, and vice versa. Converting a String containing a NULL + // pointer to ::std::string or ::string is undefined behavior. + // Converting a ::std::string or ::string containing an embedded NUL + // character to a String will result in the prefix up to the first + // NUL character. + String(const ::std::string& str) { + ConstructNonNull(str.c_str(), str.length()); + } + + operator ::std::string() const { return ::std::string(c_str(), length()); } + +#if GTEST_HAS_GLOBAL_STRING + String(const ::string& str) { + ConstructNonNull(str.c_str(), str.length()); + } + + operator ::string() const { return ::string(c_str(), length()); } +#endif // GTEST_HAS_GLOBAL_STRING + + // Returns true iff this is an empty string (i.e. ""). + bool empty() const { return (c_str() != NULL) && (length() == 0); } + + // Compares this with another String. + // Returns < 0 if this is less than rhs, 0 if this is equal to rhs, or > 0 + // if this is greater than rhs. + int Compare(const String& rhs) const; + + // Returns true iff this String equals the given C string. A NULL + // string and a non-NULL string are considered not equal. + bool operator==(const char* a_c_str) const { return Compare(a_c_str) == 0; } + + // Returns true iff this String is less than the given String. A + // NULL string is considered less than "". + bool operator<(const String& rhs) const { return Compare(rhs) < 0; } + + // Returns true iff this String doesn't equal the given C string. A NULL + // string and a non-NULL string are considered not equal. + bool operator!=(const char* a_c_str) const { return !(*this == a_c_str); } + + // Returns true iff this String ends with the given suffix. *Any* + // String is considered to end with a NULL or empty suffix. + bool EndsWith(const char* suffix) const; + + // Returns true iff this String ends with the given suffix, not considering + // case. Any String is considered to end with a NULL or empty suffix. + bool EndsWithCaseInsensitive(const char* suffix) const; + + // Returns the length of the encapsulated string, or 0 if the + // string is NULL. + size_t length() const { return length_; } + + // Gets the 0-terminated C string this String object represents. + // The String object still owns the string. Therefore the caller + // should NOT delete the return value. + const char* c_str() const { return c_str_; } + + // Assigns a C string to this object. Self-assignment works. + const String& operator=(const char* a_c_str) { + return *this = String(a_c_str); + } + + // Assigns a String object to this object. Self-assignment works. + const String& operator=(const String& rhs) { + if (this != &rhs) { + delete[] c_str_; + if (rhs.c_str() == NULL) { + c_str_ = NULL; + length_ = 0; + } else { + ConstructNonNull(rhs.c_str(), rhs.length()); + } + } + + return *this; + } + + private: + // Constructs a non-NULL String from the given content. This + // function can only be called when c_str_ has not been allocated. + // ConstructNonNull(NULL, 0) results in an empty string (""). + // ConstructNonNull(NULL, non_zero) is undefined behavior. + void ConstructNonNull(const char* buffer, size_t a_length) { + char* const str = new char[a_length + 1]; + memcpy(str, buffer, a_length); + str[a_length] = '\0'; + c_str_ = str; + length_ = a_length; + } + + const char* c_str_; + size_t length_; +}; // class String + +// Streams a String to an ostream. Each '\0' character in the String +// is replaced with "\\0". +inline ::std::ostream& operator<<(::std::ostream& os, const String& str) { + if (str.c_str() == NULL) { + os << "(null)"; + } else { + const char* const c_str = str.c_str(); + for (size_t i = 0; i != str.length(); i++) { + if (c_str[i] == '\0') { + os << "\\0"; + } else { + os << c_str[i]; + } + } + } + return os; +} + +// Gets the content of the stringstream's buffer as a String. Each '\0' +// character in the buffer is replaced with "\\0". +GTEST_API_ String StringStreamToString(::std::stringstream* stream); + +// Converts a streamable value to a String. A NULL pointer is +// converted to "(null)". When the input value is a ::string, +// ::std::string, ::wstring, or ::std::wstring object, each NUL +// character in it is replaced with "\\0". + +// Declared here but defined in gtest.h, so that it has access +// to the definition of the Message class, required by the ARM +// compiler. +template +String StreamableToString(const T& streamable); + +} // namespace internal +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h new file mode 100644 index 0000000000..20363f2ad4 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h @@ -0,0 +1,968 @@ +// This file was GENERATED by a script. DO NOT EDIT BY HAND!!! + +// Copyright 2009 Google Inc. +// All Rights Reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) + +// Implements a subset of TR1 tuple needed by Google Test and Google Mock. + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TUPLE_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TUPLE_H_ + +#include // For ::std::pair. + +// The compiler used in Symbian has a bug that prevents us from declaring the +// tuple template as a friend (it complains that tuple is redefined). This +// hack bypasses the bug by declaring the members that should otherwise be +// private as public. +// Sun Studio versions < 12 also have the above bug. +#if defined(__SYMBIAN32__) || (defined(__SUNPRO_CC) && __SUNPRO_CC < 0x590) +# define GTEST_DECLARE_TUPLE_AS_FRIEND_ public: +#else +# define GTEST_DECLARE_TUPLE_AS_FRIEND_ \ + template friend class tuple; \ + private: +#endif + +// GTEST_n_TUPLE_(T) is the type of an n-tuple. +#define GTEST_0_TUPLE_(T) tuple<> +#define GTEST_1_TUPLE_(T) tuple +#define GTEST_2_TUPLE_(T) tuple +#define GTEST_3_TUPLE_(T) tuple +#define GTEST_4_TUPLE_(T) tuple +#define GTEST_5_TUPLE_(T) tuple +#define GTEST_6_TUPLE_(T) tuple +#define GTEST_7_TUPLE_(T) tuple +#define GTEST_8_TUPLE_(T) tuple +#define GTEST_9_TUPLE_(T) tuple +#define GTEST_10_TUPLE_(T) tuple + +// GTEST_n_TYPENAMES_(T) declares a list of n typenames. +#define GTEST_0_TYPENAMES_(T) +#define GTEST_1_TYPENAMES_(T) typename T##0 +#define GTEST_2_TYPENAMES_(T) typename T##0, typename T##1 +#define GTEST_3_TYPENAMES_(T) typename T##0, typename T##1, typename T##2 +#define GTEST_4_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \ + typename T##3 +#define GTEST_5_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \ + typename T##3, typename T##4 +#define GTEST_6_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \ + typename T##3, typename T##4, typename T##5 +#define GTEST_7_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \ + typename T##3, typename T##4, typename T##5, typename T##6 +#define GTEST_8_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \ + typename T##3, typename T##4, typename T##5, typename T##6, typename T##7 +#define GTEST_9_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \ + typename T##3, typename T##4, typename T##5, typename T##6, \ + typename T##7, typename T##8 +#define GTEST_10_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \ + typename T##3, typename T##4, typename T##5, typename T##6, \ + typename T##7, typename T##8, typename T##9 + +// In theory, defining stuff in the ::std namespace is undefined +// behavior. We can do this as we are playing the role of a standard +// library vendor. +namespace std { +namespace tr1 { + +template +class tuple; + +// Anything in namespace gtest_internal is Google Test's INTERNAL +// IMPLEMENTATION DETAIL and MUST NOT BE USED DIRECTLY in user code. +namespace gtest_internal { + +// ByRef::type is T if T is a reference; otherwise it's const T&. +template +struct ByRef { typedef const T& type; }; // NOLINT +template +struct ByRef { typedef T& type; }; // NOLINT + +// A handy wrapper for ByRef. +#define GTEST_BY_REF_(T) typename ::std::tr1::gtest_internal::ByRef::type + +// AddRef::type is T if T is a reference; otherwise it's T&. This +// is the same as tr1::add_reference::type. +template +struct AddRef { typedef T& type; }; // NOLINT +template +struct AddRef { typedef T& type; }; // NOLINT + +// A handy wrapper for AddRef. +#define GTEST_ADD_REF_(T) typename ::std::tr1::gtest_internal::AddRef::type + +// A helper for implementing get(). +template class Get; + +// A helper for implementing tuple_element. kIndexValid is true +// iff k < the number of fields in tuple type T. +template +struct TupleElement; + +template +struct TupleElement { typedef T0 type; }; + +template +struct TupleElement { typedef T1 type; }; + +template +struct TupleElement { typedef T2 type; }; + +template +struct TupleElement { typedef T3 type; }; + +template +struct TupleElement { typedef T4 type; }; + +template +struct TupleElement { typedef T5 type; }; + +template +struct TupleElement { typedef T6 type; }; + +template +struct TupleElement { typedef T7 type; }; + +template +struct TupleElement { typedef T8 type; }; + +template +struct TupleElement { typedef T9 type; }; + +} // namespace gtest_internal + +template <> +class tuple<> { + public: + tuple() {} + tuple(const tuple& /* t */) {} + tuple& operator=(const tuple& /* t */) { return *this; } +}; + +template +class GTEST_1_TUPLE_(T) { + public: + template friend class gtest_internal::Get; + + tuple() : f0_() {} + + explicit tuple(GTEST_BY_REF_(T0) f0) : f0_(f0) {} + + tuple(const tuple& t) : f0_(t.f0_) {} + + template + tuple(const GTEST_1_TUPLE_(U)& t) : f0_(t.f0_) {} + + tuple& operator=(const tuple& t) { return CopyFrom(t); } + + template + tuple& operator=(const GTEST_1_TUPLE_(U)& t) { + return CopyFrom(t); + } + + GTEST_DECLARE_TUPLE_AS_FRIEND_ + + template + tuple& CopyFrom(const GTEST_1_TUPLE_(U)& t) { + f0_ = t.f0_; + return *this; + } + + T0 f0_; +}; + +template +class GTEST_2_TUPLE_(T) { + public: + template friend class gtest_internal::Get; + + tuple() : f0_(), f1_() {} + + explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1) : f0_(f0), + f1_(f1) {} + + tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_) {} + + template + tuple(const GTEST_2_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_) {} + template + tuple(const ::std::pair& p) : f0_(p.first), f1_(p.second) {} + + tuple& operator=(const tuple& t) { return CopyFrom(t); } + + template + tuple& operator=(const GTEST_2_TUPLE_(U)& t) { + return CopyFrom(t); + } + template + tuple& operator=(const ::std::pair& p) { + f0_ = p.first; + f1_ = p.second; + return *this; + } + + GTEST_DECLARE_TUPLE_AS_FRIEND_ + + template + tuple& CopyFrom(const GTEST_2_TUPLE_(U)& t) { + f0_ = t.f0_; + f1_ = t.f1_; + return *this; + } + + T0 f0_; + T1 f1_; +}; + +template +class GTEST_3_TUPLE_(T) { + public: + template friend class gtest_internal::Get; + + tuple() : f0_(), f1_(), f2_() {} + + explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1, + GTEST_BY_REF_(T2) f2) : f0_(f0), f1_(f1), f2_(f2) {} + + tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_) {} + + template + tuple(const GTEST_3_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_) {} + + tuple& operator=(const tuple& t) { return CopyFrom(t); } + + template + tuple& operator=(const GTEST_3_TUPLE_(U)& t) { + return CopyFrom(t); + } + + GTEST_DECLARE_TUPLE_AS_FRIEND_ + + template + tuple& CopyFrom(const GTEST_3_TUPLE_(U)& t) { + f0_ = t.f0_; + f1_ = t.f1_; + f2_ = t.f2_; + return *this; + } + + T0 f0_; + T1 f1_; + T2 f2_; +}; + +template +class GTEST_4_TUPLE_(T) { + public: + template friend class gtest_internal::Get; + + tuple() : f0_(), f1_(), f2_(), f3_() {} + + explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1, + GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3) : f0_(f0), f1_(f1), f2_(f2), + f3_(f3) {} + + tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_) {} + + template + tuple(const GTEST_4_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), + f3_(t.f3_) {} + + tuple& operator=(const tuple& t) { return CopyFrom(t); } + + template + tuple& operator=(const GTEST_4_TUPLE_(U)& t) { + return CopyFrom(t); + } + + GTEST_DECLARE_TUPLE_AS_FRIEND_ + + template + tuple& CopyFrom(const GTEST_4_TUPLE_(U)& t) { + f0_ = t.f0_; + f1_ = t.f1_; + f2_ = t.f2_; + f3_ = t.f3_; + return *this; + } + + T0 f0_; + T1 f1_; + T2 f2_; + T3 f3_; +}; + +template +class GTEST_5_TUPLE_(T) { + public: + template friend class gtest_internal::Get; + + tuple() : f0_(), f1_(), f2_(), f3_(), f4_() {} + + explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1, + GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3, + GTEST_BY_REF_(T4) f4) : f0_(f0), f1_(f1), f2_(f2), f3_(f3), f4_(f4) {} + + tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_), + f4_(t.f4_) {} + + template + tuple(const GTEST_5_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), + f3_(t.f3_), f4_(t.f4_) {} + + tuple& operator=(const tuple& t) { return CopyFrom(t); } + + template + tuple& operator=(const GTEST_5_TUPLE_(U)& t) { + return CopyFrom(t); + } + + GTEST_DECLARE_TUPLE_AS_FRIEND_ + + template + tuple& CopyFrom(const GTEST_5_TUPLE_(U)& t) { + f0_ = t.f0_; + f1_ = t.f1_; + f2_ = t.f2_; + f3_ = t.f3_; + f4_ = t.f4_; + return *this; + } + + T0 f0_; + T1 f1_; + T2 f2_; + T3 f3_; + T4 f4_; +}; + +template +class GTEST_6_TUPLE_(T) { + public: + template friend class gtest_internal::Get; + + tuple() : f0_(), f1_(), f2_(), f3_(), f4_(), f5_() {} + + explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1, + GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3, GTEST_BY_REF_(T4) f4, + GTEST_BY_REF_(T5) f5) : f0_(f0), f1_(f1), f2_(f2), f3_(f3), f4_(f4), + f5_(f5) {} + + tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_), + f4_(t.f4_), f5_(t.f5_) {} + + template + tuple(const GTEST_6_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), + f3_(t.f3_), f4_(t.f4_), f5_(t.f5_) {} + + tuple& operator=(const tuple& t) { return CopyFrom(t); } + + template + tuple& operator=(const GTEST_6_TUPLE_(U)& t) { + return CopyFrom(t); + } + + GTEST_DECLARE_TUPLE_AS_FRIEND_ + + template + tuple& CopyFrom(const GTEST_6_TUPLE_(U)& t) { + f0_ = t.f0_; + f1_ = t.f1_; + f2_ = t.f2_; + f3_ = t.f3_; + f4_ = t.f4_; + f5_ = t.f5_; + return *this; + } + + T0 f0_; + T1 f1_; + T2 f2_; + T3 f3_; + T4 f4_; + T5 f5_; +}; + +template +class GTEST_7_TUPLE_(T) { + public: + template friend class gtest_internal::Get; + + tuple() : f0_(), f1_(), f2_(), f3_(), f4_(), f5_(), f6_() {} + + explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1, + GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3, GTEST_BY_REF_(T4) f4, + GTEST_BY_REF_(T5) f5, GTEST_BY_REF_(T6) f6) : f0_(f0), f1_(f1), f2_(f2), + f3_(f3), f4_(f4), f5_(f5), f6_(f6) {} + + tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_), + f4_(t.f4_), f5_(t.f5_), f6_(t.f6_) {} + + template + tuple(const GTEST_7_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), + f3_(t.f3_), f4_(t.f4_), f5_(t.f5_), f6_(t.f6_) {} + + tuple& operator=(const tuple& t) { return CopyFrom(t); } + + template + tuple& operator=(const GTEST_7_TUPLE_(U)& t) { + return CopyFrom(t); + } + + GTEST_DECLARE_TUPLE_AS_FRIEND_ + + template + tuple& CopyFrom(const GTEST_7_TUPLE_(U)& t) { + f0_ = t.f0_; + f1_ = t.f1_; + f2_ = t.f2_; + f3_ = t.f3_; + f4_ = t.f4_; + f5_ = t.f5_; + f6_ = t.f6_; + return *this; + } + + T0 f0_; + T1 f1_; + T2 f2_; + T3 f3_; + T4 f4_; + T5 f5_; + T6 f6_; +}; + +template +class GTEST_8_TUPLE_(T) { + public: + template friend class gtest_internal::Get; + + tuple() : f0_(), f1_(), f2_(), f3_(), f4_(), f5_(), f6_(), f7_() {} + + explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1, + GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3, GTEST_BY_REF_(T4) f4, + GTEST_BY_REF_(T5) f5, GTEST_BY_REF_(T6) f6, + GTEST_BY_REF_(T7) f7) : f0_(f0), f1_(f1), f2_(f2), f3_(f3), f4_(f4), + f5_(f5), f6_(f6), f7_(f7) {} + + tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_), + f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_) {} + + template + tuple(const GTEST_8_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), + f3_(t.f3_), f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_) {} + + tuple& operator=(const tuple& t) { return CopyFrom(t); } + + template + tuple& operator=(const GTEST_8_TUPLE_(U)& t) { + return CopyFrom(t); + } + + GTEST_DECLARE_TUPLE_AS_FRIEND_ + + template + tuple& CopyFrom(const GTEST_8_TUPLE_(U)& t) { + f0_ = t.f0_; + f1_ = t.f1_; + f2_ = t.f2_; + f3_ = t.f3_; + f4_ = t.f4_; + f5_ = t.f5_; + f6_ = t.f6_; + f7_ = t.f7_; + return *this; + } + + T0 f0_; + T1 f1_; + T2 f2_; + T3 f3_; + T4 f4_; + T5 f5_; + T6 f6_; + T7 f7_; +}; + +template +class GTEST_9_TUPLE_(T) { + public: + template friend class gtest_internal::Get; + + tuple() : f0_(), f1_(), f2_(), f3_(), f4_(), f5_(), f6_(), f7_(), f8_() {} + + explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1, + GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3, GTEST_BY_REF_(T4) f4, + GTEST_BY_REF_(T5) f5, GTEST_BY_REF_(T6) f6, GTEST_BY_REF_(T7) f7, + GTEST_BY_REF_(T8) f8) : f0_(f0), f1_(f1), f2_(f2), f3_(f3), f4_(f4), + f5_(f5), f6_(f6), f7_(f7), f8_(f8) {} + + tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_), + f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_), f8_(t.f8_) {} + + template + tuple(const GTEST_9_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), + f3_(t.f3_), f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_), f8_(t.f8_) {} + + tuple& operator=(const tuple& t) { return CopyFrom(t); } + + template + tuple& operator=(const GTEST_9_TUPLE_(U)& t) { + return CopyFrom(t); + } + + GTEST_DECLARE_TUPLE_AS_FRIEND_ + + template + tuple& CopyFrom(const GTEST_9_TUPLE_(U)& t) { + f0_ = t.f0_; + f1_ = t.f1_; + f2_ = t.f2_; + f3_ = t.f3_; + f4_ = t.f4_; + f5_ = t.f5_; + f6_ = t.f6_; + f7_ = t.f7_; + f8_ = t.f8_; + return *this; + } + + T0 f0_; + T1 f1_; + T2 f2_; + T3 f3_; + T4 f4_; + T5 f5_; + T6 f6_; + T7 f7_; + T8 f8_; +}; + +template +class tuple { + public: + template friend class gtest_internal::Get; + + tuple() : f0_(), f1_(), f2_(), f3_(), f4_(), f5_(), f6_(), f7_(), f8_(), + f9_() {} + + explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1, + GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3, GTEST_BY_REF_(T4) f4, + GTEST_BY_REF_(T5) f5, GTEST_BY_REF_(T6) f6, GTEST_BY_REF_(T7) f7, + GTEST_BY_REF_(T8) f8, GTEST_BY_REF_(T9) f9) : f0_(f0), f1_(f1), f2_(f2), + f3_(f3), f4_(f4), f5_(f5), f6_(f6), f7_(f7), f8_(f8), f9_(f9) {} + + tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_), + f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_), f8_(t.f8_), f9_(t.f9_) {} + + template + tuple(const GTEST_10_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), + f3_(t.f3_), f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_), f8_(t.f8_), + f9_(t.f9_) {} + + tuple& operator=(const tuple& t) { return CopyFrom(t); } + + template + tuple& operator=(const GTEST_10_TUPLE_(U)& t) { + return CopyFrom(t); + } + + GTEST_DECLARE_TUPLE_AS_FRIEND_ + + template + tuple& CopyFrom(const GTEST_10_TUPLE_(U)& t) { + f0_ = t.f0_; + f1_ = t.f1_; + f2_ = t.f2_; + f3_ = t.f3_; + f4_ = t.f4_; + f5_ = t.f5_; + f6_ = t.f6_; + f7_ = t.f7_; + f8_ = t.f8_; + f9_ = t.f9_; + return *this; + } + + T0 f0_; + T1 f1_; + T2 f2_; + T3 f3_; + T4 f4_; + T5 f5_; + T6 f6_; + T7 f7_; + T8 f8_; + T9 f9_; +}; + +// 6.1.3.2 Tuple creation functions. + +// Known limitations: we don't support passing an +// std::tr1::reference_wrapper to make_tuple(). And we don't +// implement tie(). + +inline tuple<> make_tuple() { return tuple<>(); } + +template +inline GTEST_1_TUPLE_(T) make_tuple(const T0& f0) { + return GTEST_1_TUPLE_(T)(f0); +} + +template +inline GTEST_2_TUPLE_(T) make_tuple(const T0& f0, const T1& f1) { + return GTEST_2_TUPLE_(T)(f0, f1); +} + +template +inline GTEST_3_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2) { + return GTEST_3_TUPLE_(T)(f0, f1, f2); +} + +template +inline GTEST_4_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2, + const T3& f3) { + return GTEST_4_TUPLE_(T)(f0, f1, f2, f3); +} + +template +inline GTEST_5_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2, + const T3& f3, const T4& f4) { + return GTEST_5_TUPLE_(T)(f0, f1, f2, f3, f4); +} + +template +inline GTEST_6_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2, + const T3& f3, const T4& f4, const T5& f5) { + return GTEST_6_TUPLE_(T)(f0, f1, f2, f3, f4, f5); +} + +template +inline GTEST_7_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2, + const T3& f3, const T4& f4, const T5& f5, const T6& f6) { + return GTEST_7_TUPLE_(T)(f0, f1, f2, f3, f4, f5, f6); +} + +template +inline GTEST_8_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2, + const T3& f3, const T4& f4, const T5& f5, const T6& f6, const T7& f7) { + return GTEST_8_TUPLE_(T)(f0, f1, f2, f3, f4, f5, f6, f7); +} + +template +inline GTEST_9_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2, + const T3& f3, const T4& f4, const T5& f5, const T6& f6, const T7& f7, + const T8& f8) { + return GTEST_9_TUPLE_(T)(f0, f1, f2, f3, f4, f5, f6, f7, f8); +} + +template +inline GTEST_10_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2, + const T3& f3, const T4& f4, const T5& f5, const T6& f6, const T7& f7, + const T8& f8, const T9& f9) { + return GTEST_10_TUPLE_(T)(f0, f1, f2, f3, f4, f5, f6, f7, f8, f9); +} + +// 6.1.3.3 Tuple helper classes. + +template struct tuple_size; + +template +struct tuple_size { static const int value = 0; }; + +template +struct tuple_size { static const int value = 1; }; + +template +struct tuple_size { static const int value = 2; }; + +template +struct tuple_size { static const int value = 3; }; + +template +struct tuple_size { static const int value = 4; }; + +template +struct tuple_size { static const int value = 5; }; + +template +struct tuple_size { static const int value = 6; }; + +template +struct tuple_size { static const int value = 7; }; + +template +struct tuple_size { static const int value = 8; }; + +template +struct tuple_size { static const int value = 9; }; + +template +struct tuple_size { static const int value = 10; }; + +template +struct tuple_element { + typedef typename gtest_internal::TupleElement< + k < (tuple_size::value), k, Tuple>::type type; +}; + +#define GTEST_TUPLE_ELEMENT_(k, Tuple) typename tuple_element::type + +// 6.1.3.4 Element access. + +namespace gtest_internal { + +template <> +class Get<0> { + public: + template + static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(0, Tuple)) + Field(Tuple& t) { return t.f0_; } // NOLINT + + template + static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(0, Tuple)) + ConstField(const Tuple& t) { return t.f0_; } +}; + +template <> +class Get<1> { + public: + template + static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(1, Tuple)) + Field(Tuple& t) { return t.f1_; } // NOLINT + + template + static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(1, Tuple)) + ConstField(const Tuple& t) { return t.f1_; } +}; + +template <> +class Get<2> { + public: + template + static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(2, Tuple)) + Field(Tuple& t) { return t.f2_; } // NOLINT + + template + static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(2, Tuple)) + ConstField(const Tuple& t) { return t.f2_; } +}; + +template <> +class Get<3> { + public: + template + static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(3, Tuple)) + Field(Tuple& t) { return t.f3_; } // NOLINT + + template + static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(3, Tuple)) + ConstField(const Tuple& t) { return t.f3_; } +}; + +template <> +class Get<4> { + public: + template + static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(4, Tuple)) + Field(Tuple& t) { return t.f4_; } // NOLINT + + template + static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(4, Tuple)) + ConstField(const Tuple& t) { return t.f4_; } +}; + +template <> +class Get<5> { + public: + template + static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(5, Tuple)) + Field(Tuple& t) { return t.f5_; } // NOLINT + + template + static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(5, Tuple)) + ConstField(const Tuple& t) { return t.f5_; } +}; + +template <> +class Get<6> { + public: + template + static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(6, Tuple)) + Field(Tuple& t) { return t.f6_; } // NOLINT + + template + static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(6, Tuple)) + ConstField(const Tuple& t) { return t.f6_; } +}; + +template <> +class Get<7> { + public: + template + static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(7, Tuple)) + Field(Tuple& t) { return t.f7_; } // NOLINT + + template + static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(7, Tuple)) + ConstField(const Tuple& t) { return t.f7_; } +}; + +template <> +class Get<8> { + public: + template + static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(8, Tuple)) + Field(Tuple& t) { return t.f8_; } // NOLINT + + template + static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(8, Tuple)) + ConstField(const Tuple& t) { return t.f8_; } +}; + +template <> +class Get<9> { + public: + template + static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(9, Tuple)) + Field(Tuple& t) { return t.f9_; } // NOLINT + + template + static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(9, Tuple)) + ConstField(const Tuple& t) { return t.f9_; } +}; + +} // namespace gtest_internal + +template +GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(k, GTEST_10_TUPLE_(T))) +get(GTEST_10_TUPLE_(T)& t) { + return gtest_internal::Get::Field(t); +} + +template +GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(k, GTEST_10_TUPLE_(T))) +get(const GTEST_10_TUPLE_(T)& t) { + return gtest_internal::Get::ConstField(t); +} + +// 6.1.3.5 Relational operators + +// We only implement == and !=, as we don't have a need for the rest yet. + +namespace gtest_internal { + +// SameSizeTuplePrefixComparator::Eq(t1, t2) returns true if the +// first k fields of t1 equals the first k fields of t2. +// SameSizeTuplePrefixComparator(k1, k2) would be a compiler error if +// k1 != k2. +template +struct SameSizeTuplePrefixComparator; + +template <> +struct SameSizeTuplePrefixComparator<0, 0> { + template + static bool Eq(const Tuple1& /* t1 */, const Tuple2& /* t2 */) { + return true; + } +}; + +template +struct SameSizeTuplePrefixComparator { + template + static bool Eq(const Tuple1& t1, const Tuple2& t2) { + return SameSizeTuplePrefixComparator::Eq(t1, t2) && + ::std::tr1::get(t1) == ::std::tr1::get(t2); + } +}; + +} // namespace gtest_internal + +template +inline bool operator==(const GTEST_10_TUPLE_(T)& t, + const GTEST_10_TUPLE_(U)& u) { + return gtest_internal::SameSizeTuplePrefixComparator< + tuple_size::value, + tuple_size::value>::Eq(t, u); +} + +template +inline bool operator!=(const GTEST_10_TUPLE_(T)& t, + const GTEST_10_TUPLE_(U)& u) { return !(t == u); } + +// 6.1.4 Pairs. +// Unimplemented. + +} // namespace tr1 +} // namespace std + +#undef GTEST_0_TUPLE_ +#undef GTEST_1_TUPLE_ +#undef GTEST_2_TUPLE_ +#undef GTEST_3_TUPLE_ +#undef GTEST_4_TUPLE_ +#undef GTEST_5_TUPLE_ +#undef GTEST_6_TUPLE_ +#undef GTEST_7_TUPLE_ +#undef GTEST_8_TUPLE_ +#undef GTEST_9_TUPLE_ +#undef GTEST_10_TUPLE_ + +#undef GTEST_0_TYPENAMES_ +#undef GTEST_1_TYPENAMES_ +#undef GTEST_2_TYPENAMES_ +#undef GTEST_3_TYPENAMES_ +#undef GTEST_4_TYPENAMES_ +#undef GTEST_5_TYPENAMES_ +#undef GTEST_6_TYPENAMES_ +#undef GTEST_7_TYPENAMES_ +#undef GTEST_8_TYPENAMES_ +#undef GTEST_9_TYPENAMES_ +#undef GTEST_10_TYPENAMES_ + +#undef GTEST_DECLARE_TUPLE_AS_FRIEND_ +#undef GTEST_BY_REF_ +#undef GTEST_ADD_REF_ +#undef GTEST_TUPLE_ELEMENT_ + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TUPLE_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h.pump b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h.pump new file mode 100644 index 0000000000..a382ba0c3b --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-tuple.h.pump @@ -0,0 +1,336 @@ +$$ -*- mode: c++; -*- +$var n = 10 $$ Maximum number of tuple fields we want to support. +$$ This meta comment fixes auto-indentation in Emacs. }} +// Copyright 2009 Google Inc. +// All Rights Reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) + +// Implements a subset of TR1 tuple needed by Google Test and Google Mock. + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TUPLE_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TUPLE_H_ + +#include // For ::std::pair. + +// The compiler used in Symbian has a bug that prevents us from declaring the +// tuple template as a friend (it complains that tuple is redefined). This +// hack bypasses the bug by declaring the members that should otherwise be +// private as public. +// Sun Studio versions < 12 also have the above bug. +#if defined(__SYMBIAN32__) || (defined(__SUNPRO_CC) && __SUNPRO_CC < 0x590) +# define GTEST_DECLARE_TUPLE_AS_FRIEND_ public: +#else +# define GTEST_DECLARE_TUPLE_AS_FRIEND_ \ + template friend class tuple; \ + private: +#endif + + +$range i 0..n-1 +$range j 0..n +$range k 1..n +// GTEST_n_TUPLE_(T) is the type of an n-tuple. +#define GTEST_0_TUPLE_(T) tuple<> + +$for k [[ +$range m 0..k-1 +$range m2 k..n-1 +#define GTEST_$(k)_TUPLE_(T) tuple<$for m, [[T##$m]]$for m2 [[, void]]> + +]] + +// GTEST_n_TYPENAMES_(T) declares a list of n typenames. + +$for j [[ +$range m 0..j-1 +#define GTEST_$(j)_TYPENAMES_(T) $for m, [[typename T##$m]] + + +]] + +// In theory, defining stuff in the ::std namespace is undefined +// behavior. We can do this as we are playing the role of a standard +// library vendor. +namespace std { +namespace tr1 { + +template <$for i, [[typename T$i = void]]> +class tuple; + +// Anything in namespace gtest_internal is Google Test's INTERNAL +// IMPLEMENTATION DETAIL and MUST NOT BE USED DIRECTLY in user code. +namespace gtest_internal { + +// ByRef::type is T if T is a reference; otherwise it's const T&. +template +struct ByRef { typedef const T& type; }; // NOLINT +template +struct ByRef { typedef T& type; }; // NOLINT + +// A handy wrapper for ByRef. +#define GTEST_BY_REF_(T) typename ::std::tr1::gtest_internal::ByRef::type + +// AddRef::type is T if T is a reference; otherwise it's T&. This +// is the same as tr1::add_reference::type. +template +struct AddRef { typedef T& type; }; // NOLINT +template +struct AddRef { typedef T& type; }; // NOLINT + +// A handy wrapper for AddRef. +#define GTEST_ADD_REF_(T) typename ::std::tr1::gtest_internal::AddRef::type + +// A helper for implementing get(). +template class Get; + +// A helper for implementing tuple_element. kIndexValid is true +// iff k < the number of fields in tuple type T. +template +struct TupleElement; + + +$for i [[ +template +struct TupleElement [[]] +{ typedef T$i type; }; + + +]] +} // namespace gtest_internal + +template <> +class tuple<> { + public: + tuple() {} + tuple(const tuple& /* t */) {} + tuple& operator=(const tuple& /* t */) { return *this; } +}; + + +$for k [[ +$range m 0..k-1 +template +class $if k < n [[GTEST_$(k)_TUPLE_(T)]] $else [[tuple]] { + public: + template friend class gtest_internal::Get; + + tuple() : $for m, [[f$(m)_()]] {} + + explicit tuple($for m, [[GTEST_BY_REF_(T$m) f$m]]) : [[]] +$for m, [[f$(m)_(f$m)]] {} + + tuple(const tuple& t) : $for m, [[f$(m)_(t.f$(m)_)]] {} + + template + tuple(const GTEST_$(k)_TUPLE_(U)& t) : $for m, [[f$(m)_(t.f$(m)_)]] {} + +$if k == 2 [[ + template + tuple(const ::std::pair& p) : f0_(p.first), f1_(p.second) {} + +]] + + tuple& operator=(const tuple& t) { return CopyFrom(t); } + + template + tuple& operator=(const GTEST_$(k)_TUPLE_(U)& t) { + return CopyFrom(t); + } + +$if k == 2 [[ + template + tuple& operator=(const ::std::pair& p) { + f0_ = p.first; + f1_ = p.second; + return *this; + } + +]] + + GTEST_DECLARE_TUPLE_AS_FRIEND_ + + template + tuple& CopyFrom(const GTEST_$(k)_TUPLE_(U)& t) { + +$for m [[ + f$(m)_ = t.f$(m)_; + +]] + return *this; + } + + +$for m [[ + T$m f$(m)_; + +]] +}; + + +]] +// 6.1.3.2 Tuple creation functions. + +// Known limitations: we don't support passing an +// std::tr1::reference_wrapper to make_tuple(). And we don't +// implement tie(). + +inline tuple<> make_tuple() { return tuple<>(); } + +$for k [[ +$range m 0..k-1 + +template +inline GTEST_$(k)_TUPLE_(T) make_tuple($for m, [[const T$m& f$m]]) { + return GTEST_$(k)_TUPLE_(T)($for m, [[f$m]]); +} + +]] + +// 6.1.3.3 Tuple helper classes. + +template struct tuple_size; + + +$for j [[ +template +struct tuple_size { static const int value = $j; }; + + +]] +template +struct tuple_element { + typedef typename gtest_internal::TupleElement< + k < (tuple_size::value), k, Tuple>::type type; +}; + +#define GTEST_TUPLE_ELEMENT_(k, Tuple) typename tuple_element::type + +// 6.1.3.4 Element access. + +namespace gtest_internal { + + +$for i [[ +template <> +class Get<$i> { + public: + template + static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_($i, Tuple)) + Field(Tuple& t) { return t.f$(i)_; } // NOLINT + + template + static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_($i, Tuple)) + ConstField(const Tuple& t) { return t.f$(i)_; } +}; + + +]] +} // namespace gtest_internal + +template +GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(k, GTEST_$(n)_TUPLE_(T))) +get(GTEST_$(n)_TUPLE_(T)& t) { + return gtest_internal::Get::Field(t); +} + +template +GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(k, GTEST_$(n)_TUPLE_(T))) +get(const GTEST_$(n)_TUPLE_(T)& t) { + return gtest_internal::Get::ConstField(t); +} + +// 6.1.3.5 Relational operators + +// We only implement == and !=, as we don't have a need for the rest yet. + +namespace gtest_internal { + +// SameSizeTuplePrefixComparator::Eq(t1, t2) returns true if the +// first k fields of t1 equals the first k fields of t2. +// SameSizeTuplePrefixComparator(k1, k2) would be a compiler error if +// k1 != k2. +template +struct SameSizeTuplePrefixComparator; + +template <> +struct SameSizeTuplePrefixComparator<0, 0> { + template + static bool Eq(const Tuple1& /* t1 */, const Tuple2& /* t2 */) { + return true; + } +}; + +template +struct SameSizeTuplePrefixComparator { + template + static bool Eq(const Tuple1& t1, const Tuple2& t2) { + return SameSizeTuplePrefixComparator::Eq(t1, t2) && + ::std::tr1::get(t1) == ::std::tr1::get(t2); + } +}; + +} // namespace gtest_internal + +template +inline bool operator==(const GTEST_$(n)_TUPLE_(T)& t, + const GTEST_$(n)_TUPLE_(U)& u) { + return gtest_internal::SameSizeTuplePrefixComparator< + tuple_size::value, + tuple_size::value>::Eq(t, u); +} + +template +inline bool operator!=(const GTEST_$(n)_TUPLE_(T)& t, + const GTEST_$(n)_TUPLE_(U)& u) { return !(t == u); } + +// 6.1.4 Pairs. +// Unimplemented. + +} // namespace tr1 +} // namespace std + + +$for j [[ +#undef GTEST_$(j)_TUPLE_ + +]] + + +$for j [[ +#undef GTEST_$(j)_TYPENAMES_ + +]] + +#undef GTEST_DECLARE_TUPLE_AS_FRIEND_ +#undef GTEST_BY_REF_ +#undef GTEST_ADD_REF_ +#undef GTEST_TUPLE_ELEMENT_ + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TUPLE_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h new file mode 100644 index 0000000000..ac0e025b1a --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h @@ -0,0 +1,3330 @@ +// This file was GENERATED by command: +// pump.py gtest-type-util.h.pump +// DO NOT EDIT BY HAND!!! + +// Copyright 2008 Google Inc. +// All Rights Reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) + +// Type utilities needed for implementing typed and type-parameterized +// tests. This file is generated by a SCRIPT. DO NOT EDIT BY HAND! +// +// Currently we support at most 50 types in a list, and at most 50 +// type-parameterized tests in one type-parameterized test case. +// Please contact googletestframework@googlegroups.com if you need +// more. + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TYPE_UTIL_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TYPE_UTIL_H_ + +#include "gtest/internal/gtest-port.h" +#include "gtest/internal/gtest-string.h" + +// #ifdef __GNUC__ is too general here. It is possible to use gcc without using +// libstdc++ (which is where cxxabi.h comes from). +# ifdef __GLIBCXX__ +# include +# elif defined(__HP_aCC) +# include +# endif // __GLIBCXX__ + +namespace testing { +namespace internal { + +// GetTypeName() returns a human-readable name of type T. +// NB: This function is also used in Google Mock, so don't move it inside of +// the typed-test-only section below. +template +String GetTypeName() { +# if GTEST_HAS_RTTI + + const char* const name = typeid(T).name(); +# if defined(__GLIBCXX__) || defined(__HP_aCC) + int status = 0; + // gcc's implementation of typeid(T).name() mangles the type name, + // so we have to demangle it. +# ifdef __GLIBCXX__ + using abi::__cxa_demangle; +# endif // __GLIBCXX__ + char* const readable_name = __cxa_demangle(name, 0, 0, &status); + const String name_str(status == 0 ? readable_name : name); + free(readable_name); + return name_str; +# else + return name; +# endif // __GLIBCXX__ || __HP_aCC + +# else + + return ""; + +# endif // GTEST_HAS_RTTI +} + +#if GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P + +// AssertyTypeEq::type is defined iff T1 and T2 are the same +// type. This can be used as a compile-time assertion to ensure that +// two types are equal. + +template +struct AssertTypeEq; + +template +struct AssertTypeEq { + typedef bool type; +}; + +// A unique type used as the default value for the arguments of class +// template Types. This allows us to simulate variadic templates +// (e.g. Types, Type, and etc), which C++ doesn't +// support directly. +struct None {}; + +// The following family of struct and struct templates are used to +// represent type lists. In particular, TypesN +// represents a type list with N types (T1, T2, ..., and TN) in it. +// Except for Types0, every struct in the family has two member types: +// Head for the first type in the list, and Tail for the rest of the +// list. + +// The empty type list. +struct Types0 {}; + +// Type lists of length 1, 2, 3, and so on. + +template +struct Types1 { + typedef T1 Head; + typedef Types0 Tail; +}; +template +struct Types2 { + typedef T1 Head; + typedef Types1 Tail; +}; + +template +struct Types3 { + typedef T1 Head; + typedef Types2 Tail; +}; + +template +struct Types4 { + typedef T1 Head; + typedef Types3 Tail; +}; + +template +struct Types5 { + typedef T1 Head; + typedef Types4 Tail; +}; + +template +struct Types6 { + typedef T1 Head; + typedef Types5 Tail; +}; + +template +struct Types7 { + typedef T1 Head; + typedef Types6 Tail; +}; + +template +struct Types8 { + typedef T1 Head; + typedef Types7 Tail; +}; + +template +struct Types9 { + typedef T1 Head; + typedef Types8 Tail; +}; + +template +struct Types10 { + typedef T1 Head; + typedef Types9 Tail; +}; + +template +struct Types11 { + typedef T1 Head; + typedef Types10 Tail; +}; + +template +struct Types12 { + typedef T1 Head; + typedef Types11 Tail; +}; + +template +struct Types13 { + typedef T1 Head; + typedef Types12 Tail; +}; + +template +struct Types14 { + typedef T1 Head; + typedef Types13 Tail; +}; + +template +struct Types15 { + typedef T1 Head; + typedef Types14 Tail; +}; + +template +struct Types16 { + typedef T1 Head; + typedef Types15 Tail; +}; + +template +struct Types17 { + typedef T1 Head; + typedef Types16 Tail; +}; + +template +struct Types18 { + typedef T1 Head; + typedef Types17 Tail; +}; + +template +struct Types19 { + typedef T1 Head; + typedef Types18 Tail; +}; + +template +struct Types20 { + typedef T1 Head; + typedef Types19 Tail; +}; + +template +struct Types21 { + typedef T1 Head; + typedef Types20 Tail; +}; + +template +struct Types22 { + typedef T1 Head; + typedef Types21 Tail; +}; + +template +struct Types23 { + typedef T1 Head; + typedef Types22 Tail; +}; + +template +struct Types24 { + typedef T1 Head; + typedef Types23 Tail; +}; + +template +struct Types25 { + typedef T1 Head; + typedef Types24 Tail; +}; + +template +struct Types26 { + typedef T1 Head; + typedef Types25 Tail; +}; + +template +struct Types27 { + typedef T1 Head; + typedef Types26 Tail; +}; + +template +struct Types28 { + typedef T1 Head; + typedef Types27 Tail; +}; + +template +struct Types29 { + typedef T1 Head; + typedef Types28 Tail; +}; + +template +struct Types30 { + typedef T1 Head; + typedef Types29 Tail; +}; + +template +struct Types31 { + typedef T1 Head; + typedef Types30 Tail; +}; + +template +struct Types32 { + typedef T1 Head; + typedef Types31 Tail; +}; + +template +struct Types33 { + typedef T1 Head; + typedef Types32 Tail; +}; + +template +struct Types34 { + typedef T1 Head; + typedef Types33 Tail; +}; + +template +struct Types35 { + typedef T1 Head; + typedef Types34 Tail; +}; + +template +struct Types36 { + typedef T1 Head; + typedef Types35 Tail; +}; + +template +struct Types37 { + typedef T1 Head; + typedef Types36 Tail; +}; + +template +struct Types38 { + typedef T1 Head; + typedef Types37 Tail; +}; + +template +struct Types39 { + typedef T1 Head; + typedef Types38 Tail; +}; + +template +struct Types40 { + typedef T1 Head; + typedef Types39 Tail; +}; + +template +struct Types41 { + typedef T1 Head; + typedef Types40 Tail; +}; + +template +struct Types42 { + typedef T1 Head; + typedef Types41 Tail; +}; + +template +struct Types43 { + typedef T1 Head; + typedef Types42 Tail; +}; + +template +struct Types44 { + typedef T1 Head; + typedef Types43 Tail; +}; + +template +struct Types45 { + typedef T1 Head; + typedef Types44 Tail; +}; + +template +struct Types46 { + typedef T1 Head; + typedef Types45 Tail; +}; + +template +struct Types47 { + typedef T1 Head; + typedef Types46 Tail; +}; + +template +struct Types48 { + typedef T1 Head; + typedef Types47 Tail; +}; + +template +struct Types49 { + typedef T1 Head; + typedef Types48 Tail; +}; + +template +struct Types50 { + typedef T1 Head; + typedef Types49 Tail; +}; + + +} // namespace internal + +// We don't want to require the users to write TypesN<...> directly, +// as that would require them to count the length. Types<...> is much +// easier to write, but generates horrible messages when there is a +// compiler error, as gcc insists on printing out each template +// argument, even if it has the default value (this means Types +// will appear as Types in the compiler +// errors). +// +// Our solution is to combine the best part of the two approaches: a +// user would write Types, and Google Test will translate +// that to TypesN internally to make error messages +// readable. The translation is done by the 'type' member of the +// Types template. +template +struct Types { + typedef internal::Types50 type; +}; + +template <> +struct Types { + typedef internal::Types0 type; +}; +template +struct Types { + typedef internal::Types1 type; +}; +template +struct Types { + typedef internal::Types2 type; +}; +template +struct Types { + typedef internal::Types3 type; +}; +template +struct Types { + typedef internal::Types4 type; +}; +template +struct Types { + typedef internal::Types5 type; +}; +template +struct Types { + typedef internal::Types6 type; +}; +template +struct Types { + typedef internal::Types7 type; +}; +template +struct Types { + typedef internal::Types8 type; +}; +template +struct Types { + typedef internal::Types9 type; +}; +template +struct Types { + typedef internal::Types10 type; +}; +template +struct Types { + typedef internal::Types11 type; +}; +template +struct Types { + typedef internal::Types12 type; +}; +template +struct Types { + typedef internal::Types13 type; +}; +template +struct Types { + typedef internal::Types14 type; +}; +template +struct Types { + typedef internal::Types15 type; +}; +template +struct Types { + typedef internal::Types16 type; +}; +template +struct Types { + typedef internal::Types17 type; +}; +template +struct Types { + typedef internal::Types18 type; +}; +template +struct Types { + typedef internal::Types19 type; +}; +template +struct Types { + typedef internal::Types20 type; +}; +template +struct Types { + typedef internal::Types21 type; +}; +template +struct Types { + typedef internal::Types22 type; +}; +template +struct Types { + typedef internal::Types23 type; +}; +template +struct Types { + typedef internal::Types24 type; +}; +template +struct Types { + typedef internal::Types25 type; +}; +template +struct Types { + typedef internal::Types26 type; +}; +template +struct Types { + typedef internal::Types27 type; +}; +template +struct Types { + typedef internal::Types28 type; +}; +template +struct Types { + typedef internal::Types29 type; +}; +template +struct Types { + typedef internal::Types30 type; +}; +template +struct Types { + typedef internal::Types31 type; +}; +template +struct Types { + typedef internal::Types32 type; +}; +template +struct Types { + typedef internal::Types33 type; +}; +template +struct Types { + typedef internal::Types34 type; +}; +template +struct Types { + typedef internal::Types35 type; +}; +template +struct Types { + typedef internal::Types36 type; +}; +template +struct Types { + typedef internal::Types37 type; +}; +template +struct Types { + typedef internal::Types38 type; +}; +template +struct Types { + typedef internal::Types39 type; +}; +template +struct Types { + typedef internal::Types40 type; +}; +template +struct Types { + typedef internal::Types41 type; +}; +template +struct Types { + typedef internal::Types42 type; +}; +template +struct Types { + typedef internal::Types43 type; +}; +template +struct Types { + typedef internal::Types44 type; +}; +template +struct Types { + typedef internal::Types45 type; +}; +template +struct Types { + typedef internal::Types46 type; +}; +template +struct Types { + typedef internal::Types47 type; +}; +template +struct Types { + typedef internal::Types48 type; +}; +template +struct Types { + typedef internal::Types49 type; +}; + +namespace internal { + +# define GTEST_TEMPLATE_ template class + +// The template "selector" struct TemplateSel is used to +// represent Tmpl, which must be a class template with one type +// parameter, as a type. TemplateSel::Bind::type is defined +// as the type Tmpl. This allows us to actually instantiate the +// template "selected" by TemplateSel. +// +// This trick is necessary for simulating typedef for class templates, +// which C++ doesn't support directly. +template +struct TemplateSel { + template + struct Bind { + typedef Tmpl type; + }; +}; + +# define GTEST_BIND_(TmplSel, T) \ + TmplSel::template Bind::type + +// A unique struct template used as the default value for the +// arguments of class template Templates. This allows us to simulate +// variadic templates (e.g. Templates, Templates, +// and etc), which C++ doesn't support directly. +template +struct NoneT {}; + +// The following family of struct and struct templates are used to +// represent template lists. In particular, TemplatesN represents a list of N templates (T1, T2, ..., and TN). Except +// for Templates0, every struct in the family has two member types: +// Head for the selector of the first template in the list, and Tail +// for the rest of the list. + +// The empty template list. +struct Templates0 {}; + +// Template lists of length 1, 2, 3, and so on. + +template +struct Templates1 { + typedef TemplateSel Head; + typedef Templates0 Tail; +}; +template +struct Templates2 { + typedef TemplateSel Head; + typedef Templates1 Tail; +}; + +template +struct Templates3 { + typedef TemplateSel Head; + typedef Templates2 Tail; +}; + +template +struct Templates4 { + typedef TemplateSel Head; + typedef Templates3 Tail; +}; + +template +struct Templates5 { + typedef TemplateSel Head; + typedef Templates4 Tail; +}; + +template +struct Templates6 { + typedef TemplateSel Head; + typedef Templates5 Tail; +}; + +template +struct Templates7 { + typedef TemplateSel Head; + typedef Templates6 Tail; +}; + +template +struct Templates8 { + typedef TemplateSel Head; + typedef Templates7 Tail; +}; + +template +struct Templates9 { + typedef TemplateSel Head; + typedef Templates8 Tail; +}; + +template +struct Templates10 { + typedef TemplateSel Head; + typedef Templates9 Tail; +}; + +template +struct Templates11 { + typedef TemplateSel Head; + typedef Templates10 Tail; +}; + +template +struct Templates12 { + typedef TemplateSel Head; + typedef Templates11 Tail; +}; + +template +struct Templates13 { + typedef TemplateSel Head; + typedef Templates12 Tail; +}; + +template +struct Templates14 { + typedef TemplateSel Head; + typedef Templates13 Tail; +}; + +template +struct Templates15 { + typedef TemplateSel Head; + typedef Templates14 Tail; +}; + +template +struct Templates16 { + typedef TemplateSel Head; + typedef Templates15 Tail; +}; + +template +struct Templates17 { + typedef TemplateSel Head; + typedef Templates16 Tail; +}; + +template +struct Templates18 { + typedef TemplateSel Head; + typedef Templates17 Tail; +}; + +template +struct Templates19 { + typedef TemplateSel Head; + typedef Templates18 Tail; +}; + +template +struct Templates20 { + typedef TemplateSel Head; + typedef Templates19 Tail; +}; + +template +struct Templates21 { + typedef TemplateSel Head; + typedef Templates20 Tail; +}; + +template +struct Templates22 { + typedef TemplateSel Head; + typedef Templates21 Tail; +}; + +template +struct Templates23 { + typedef TemplateSel Head; + typedef Templates22 Tail; +}; + +template +struct Templates24 { + typedef TemplateSel Head; + typedef Templates23 Tail; +}; + +template +struct Templates25 { + typedef TemplateSel Head; + typedef Templates24 Tail; +}; + +template +struct Templates26 { + typedef TemplateSel Head; + typedef Templates25 Tail; +}; + +template +struct Templates27 { + typedef TemplateSel Head; + typedef Templates26 Tail; +}; + +template +struct Templates28 { + typedef TemplateSel Head; + typedef Templates27 Tail; +}; + +template +struct Templates29 { + typedef TemplateSel Head; + typedef Templates28 Tail; +}; + +template +struct Templates30 { + typedef TemplateSel Head; + typedef Templates29 Tail; +}; + +template +struct Templates31 { + typedef TemplateSel Head; + typedef Templates30 Tail; +}; + +template +struct Templates32 { + typedef TemplateSel Head; + typedef Templates31 Tail; +}; + +template +struct Templates33 { + typedef TemplateSel Head; + typedef Templates32 Tail; +}; + +template +struct Templates34 { + typedef TemplateSel Head; + typedef Templates33 Tail; +}; + +template +struct Templates35 { + typedef TemplateSel Head; + typedef Templates34 Tail; +}; + +template +struct Templates36 { + typedef TemplateSel Head; + typedef Templates35 Tail; +}; + +template +struct Templates37 { + typedef TemplateSel Head; + typedef Templates36 Tail; +}; + +template +struct Templates38 { + typedef TemplateSel Head; + typedef Templates37 Tail; +}; + +template +struct Templates39 { + typedef TemplateSel Head; + typedef Templates38 Tail; +}; + +template +struct Templates40 { + typedef TemplateSel Head; + typedef Templates39 Tail; +}; + +template +struct Templates41 { + typedef TemplateSel Head; + typedef Templates40 Tail; +}; + +template +struct Templates42 { + typedef TemplateSel Head; + typedef Templates41 Tail; +}; + +template +struct Templates43 { + typedef TemplateSel Head; + typedef Templates42 Tail; +}; + +template +struct Templates44 { + typedef TemplateSel Head; + typedef Templates43 Tail; +}; + +template +struct Templates45 { + typedef TemplateSel Head; + typedef Templates44 Tail; +}; + +template +struct Templates46 { + typedef TemplateSel Head; + typedef Templates45 Tail; +}; + +template +struct Templates47 { + typedef TemplateSel Head; + typedef Templates46 Tail; +}; + +template +struct Templates48 { + typedef TemplateSel Head; + typedef Templates47 Tail; +}; + +template +struct Templates49 { + typedef TemplateSel Head; + typedef Templates48 Tail; +}; + +template +struct Templates50 { + typedef TemplateSel Head; + typedef Templates49 Tail; +}; + + +// We don't want to require the users to write TemplatesN<...> directly, +// as that would require them to count the length. Templates<...> is much +// easier to write, but generates horrible messages when there is a +// compiler error, as gcc insists on printing out each template +// argument, even if it has the default value (this means Templates +// will appear as Templates in the compiler +// errors). +// +// Our solution is to combine the best part of the two approaches: a +// user would write Templates, and Google Test will translate +// that to TemplatesN internally to make error messages +// readable. The translation is done by the 'type' member of the +// Templates template. +template +struct Templates { + typedef Templates50 type; +}; + +template <> +struct Templates { + typedef Templates0 type; +}; +template +struct Templates { + typedef Templates1 type; +}; +template +struct Templates { + typedef Templates2 type; +}; +template +struct Templates { + typedef Templates3 type; +}; +template +struct Templates { + typedef Templates4 type; +}; +template +struct Templates { + typedef Templates5 type; +}; +template +struct Templates { + typedef Templates6 type; +}; +template +struct Templates { + typedef Templates7 type; +}; +template +struct Templates { + typedef Templates8 type; +}; +template +struct Templates { + typedef Templates9 type; +}; +template +struct Templates { + typedef Templates10 type; +}; +template +struct Templates { + typedef Templates11 type; +}; +template +struct Templates { + typedef Templates12 type; +}; +template +struct Templates { + typedef Templates13 type; +}; +template +struct Templates { + typedef Templates14 type; +}; +template +struct Templates { + typedef Templates15 type; +}; +template +struct Templates { + typedef Templates16 type; +}; +template +struct Templates { + typedef Templates17 type; +}; +template +struct Templates { + typedef Templates18 type; +}; +template +struct Templates { + typedef Templates19 type; +}; +template +struct Templates { + typedef Templates20 type; +}; +template +struct Templates { + typedef Templates21 type; +}; +template +struct Templates { + typedef Templates22 type; +}; +template +struct Templates { + typedef Templates23 type; +}; +template +struct Templates { + typedef Templates24 type; +}; +template +struct Templates { + typedef Templates25 type; +}; +template +struct Templates { + typedef Templates26 type; +}; +template +struct Templates { + typedef Templates27 type; +}; +template +struct Templates { + typedef Templates28 type; +}; +template +struct Templates { + typedef Templates29 type; +}; +template +struct Templates { + typedef Templates30 type; +}; +template +struct Templates { + typedef Templates31 type; +}; +template +struct Templates { + typedef Templates32 type; +}; +template +struct Templates { + typedef Templates33 type; +}; +template +struct Templates { + typedef Templates34 type; +}; +template +struct Templates { + typedef Templates35 type; +}; +template +struct Templates { + typedef Templates36 type; +}; +template +struct Templates { + typedef Templates37 type; +}; +template +struct Templates { + typedef Templates38 type; +}; +template +struct Templates { + typedef Templates39 type; +}; +template +struct Templates { + typedef Templates40 type; +}; +template +struct Templates { + typedef Templates41 type; +}; +template +struct Templates { + typedef Templates42 type; +}; +template +struct Templates { + typedef Templates43 type; +}; +template +struct Templates { + typedef Templates44 type; +}; +template +struct Templates { + typedef Templates45 type; +}; +template +struct Templates { + typedef Templates46 type; +}; +template +struct Templates { + typedef Templates47 type; +}; +template +struct Templates { + typedef Templates48 type; +}; +template +struct Templates { + typedef Templates49 type; +}; + +// The TypeList template makes it possible to use either a single type +// or a Types<...> list in TYPED_TEST_CASE() and +// INSTANTIATE_TYPED_TEST_CASE_P(). + +template +struct TypeList { typedef Types1 type; }; + +template +struct TypeList > { + typedef typename Types::type type; +}; + +#endif // GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P + +} // namespace internal +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TYPE_UTIL_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h.pump b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h.pump new file mode 100644 index 0000000000..c2d4c01574 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/include/gtest/internal/gtest-type-util.h.pump @@ -0,0 +1,296 @@ +$$ -*- mode: c++; -*- +$var n = 50 $$ Maximum length of type lists we want to support. +// Copyright 2008 Google Inc. +// All Rights Reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) + +// Type utilities needed for implementing typed and type-parameterized +// tests. This file is generated by a SCRIPT. DO NOT EDIT BY HAND! +// +// Currently we support at most $n types in a list, and at most $n +// type-parameterized tests in one type-parameterized test case. +// Please contact googletestframework@googlegroups.com if you need +// more. + +#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TYPE_UTIL_H_ +#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TYPE_UTIL_H_ + +#include "gtest/internal/gtest-port.h" +#include "gtest/internal/gtest-string.h" + +// #ifdef __GNUC__ is too general here. It is possible to use gcc without using +// libstdc++ (which is where cxxabi.h comes from). +# ifdef __GLIBCXX__ +# include +# elif defined(__HP_aCC) +# include +# endif // __GLIBCXX__ + +namespace testing { +namespace internal { + +// GetTypeName() returns a human-readable name of type T. +// NB: This function is also used in Google Mock, so don't move it inside of +// the typed-test-only section below. +template +String GetTypeName() { +# if GTEST_HAS_RTTI + + const char* const name = typeid(T).name(); +# if defined(__GLIBCXX__) || defined(__HP_aCC) + int status = 0; + // gcc's implementation of typeid(T).name() mangles the type name, + // so we have to demangle it. +# ifdef __GLIBCXX__ + using abi::__cxa_demangle; +# endif // __GLIBCXX__ + char* const readable_name = __cxa_demangle(name, 0, 0, &status); + const String name_str(status == 0 ? readable_name : name); + free(readable_name); + return name_str; +# else + return name; +# endif // __GLIBCXX__ || __HP_aCC + +# else + + return ""; + +# endif // GTEST_HAS_RTTI +} + +#if GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P + +// AssertyTypeEq::type is defined iff T1 and T2 are the same +// type. This can be used as a compile-time assertion to ensure that +// two types are equal. + +template +struct AssertTypeEq; + +template +struct AssertTypeEq { + typedef bool type; +}; + +// A unique type used as the default value for the arguments of class +// template Types. This allows us to simulate variadic templates +// (e.g. Types, Type, and etc), which C++ doesn't +// support directly. +struct None {}; + +// The following family of struct and struct templates are used to +// represent type lists. In particular, TypesN +// represents a type list with N types (T1, T2, ..., and TN) in it. +// Except for Types0, every struct in the family has two member types: +// Head for the first type in the list, and Tail for the rest of the +// list. + +// The empty type list. +struct Types0 {}; + +// Type lists of length 1, 2, 3, and so on. + +template +struct Types1 { + typedef T1 Head; + typedef Types0 Tail; +}; + +$range i 2..n + +$for i [[ +$range j 1..i +$range k 2..i +template <$for j, [[typename T$j]]> +struct Types$i { + typedef T1 Head; + typedef Types$(i-1)<$for k, [[T$k]]> Tail; +}; + + +]] + +} // namespace internal + +// We don't want to require the users to write TypesN<...> directly, +// as that would require them to count the length. Types<...> is much +// easier to write, but generates horrible messages when there is a +// compiler error, as gcc insists on printing out each template +// argument, even if it has the default value (this means Types +// will appear as Types in the compiler +// errors). +// +// Our solution is to combine the best part of the two approaches: a +// user would write Types, and Google Test will translate +// that to TypesN internally to make error messages +// readable. The translation is done by the 'type' member of the +// Types template. + +$range i 1..n +template <$for i, [[typename T$i = internal::None]]> +struct Types { + typedef internal::Types$n<$for i, [[T$i]]> type; +}; + +template <> +struct Types<$for i, [[internal::None]]> { + typedef internal::Types0 type; +}; + +$range i 1..n-1 +$for i [[ +$range j 1..i +$range k i+1..n +template <$for j, [[typename T$j]]> +struct Types<$for j, [[T$j]]$for k[[, internal::None]]> { + typedef internal::Types$i<$for j, [[T$j]]> type; +}; + +]] + +namespace internal { + +# define GTEST_TEMPLATE_ template class + +// The template "selector" struct TemplateSel is used to +// represent Tmpl, which must be a class template with one type +// parameter, as a type. TemplateSel::Bind::type is defined +// as the type Tmpl. This allows us to actually instantiate the +// template "selected" by TemplateSel. +// +// This trick is necessary for simulating typedef for class templates, +// which C++ doesn't support directly. +template +struct TemplateSel { + template + struct Bind { + typedef Tmpl type; + }; +}; + +# define GTEST_BIND_(TmplSel, T) \ + TmplSel::template Bind::type + +// A unique struct template used as the default value for the +// arguments of class template Templates. This allows us to simulate +// variadic templates (e.g. Templates, Templates, +// and etc), which C++ doesn't support directly. +template +struct NoneT {}; + +// The following family of struct and struct templates are used to +// represent template lists. In particular, TemplatesN represents a list of N templates (T1, T2, ..., and TN). Except +// for Templates0, every struct in the family has two member types: +// Head for the selector of the first template in the list, and Tail +// for the rest of the list. + +// The empty template list. +struct Templates0 {}; + +// Template lists of length 1, 2, 3, and so on. + +template +struct Templates1 { + typedef TemplateSel Head; + typedef Templates0 Tail; +}; + +$range i 2..n + +$for i [[ +$range j 1..i +$range k 2..i +template <$for j, [[GTEST_TEMPLATE_ T$j]]> +struct Templates$i { + typedef TemplateSel Head; + typedef Templates$(i-1)<$for k, [[T$k]]> Tail; +}; + + +]] + +// We don't want to require the users to write TemplatesN<...> directly, +// as that would require them to count the length. Templates<...> is much +// easier to write, but generates horrible messages when there is a +// compiler error, as gcc insists on printing out each template +// argument, even if it has the default value (this means Templates +// will appear as Templates in the compiler +// errors). +// +// Our solution is to combine the best part of the two approaches: a +// user would write Templates, and Google Test will translate +// that to TemplatesN internally to make error messages +// readable. The translation is done by the 'type' member of the +// Templates template. + +$range i 1..n +template <$for i, [[GTEST_TEMPLATE_ T$i = NoneT]]> +struct Templates { + typedef Templates$n<$for i, [[T$i]]> type; +}; + +template <> +struct Templates<$for i, [[NoneT]]> { + typedef Templates0 type; +}; + +$range i 1..n-1 +$for i [[ +$range j 1..i +$range k i+1..n +template <$for j, [[GTEST_TEMPLATE_ T$j]]> +struct Templates<$for j, [[T$j]]$for k[[, NoneT]]> { + typedef Templates$i<$for j, [[T$j]]> type; +}; + +]] + +// The TypeList template makes it possible to use either a single type +// or a Types<...> list in TYPED_TEST_CASE() and +// INSTANTIATE_TYPED_TEST_CASE_P(). + +template +struct TypeList { typedef Types1 type; }; + + +$range i 1..n +template <$for i, [[typename T$i]]> +struct TypeList > { + typedef typename Types<$for i, [[T$i]]>::type type; +}; + +#endif // GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P + +} // namespace internal +} // namespace testing + +#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TYPE_UTIL_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-all.cc b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-all.cc new file mode 100644 index 0000000000..e7cb13b1fc --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-all.cc @@ -0,0 +1,48 @@ +// Copyright 2008, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: mheule@google.com (Markus Heule) +// +// Google C++ Testing Framework (Google Test) +// +// Sometimes it's desirable to build Google Test by compiling a single file. +// This file serves this purpose. + +// This line ensures that gtest.h can be compiled on its own, even +// when it's fused. +#include "gtest/gtest.h" + +// The following lines pull in the real gtest *.cc files. +#include "src/gtest.cc" +#include "src/gtest-death-test.cc" +#include "src/gtest-filepath.cc" +#include "src/gtest-port.cc" +#include "src/gtest-printers.cc" +#include "src/gtest-test-part.cc" +#include "src/gtest-typed-test.cc" diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-death-test.cc b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-death-test.cc new file mode 100644 index 0000000000..9197f96c5b --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-death-test.cc @@ -0,0 +1,1234 @@ +// Copyright 2005, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan), vladl@google.com (Vlad Losev) +// +// This file implements death tests. + +#include "gtest/gtest-death-test.h" +#include "gtest/internal/gtest-port.h" + +#if GTEST_HAS_DEATH_TEST + +# if GTEST_OS_MAC +# include +# endif // GTEST_OS_MAC + +# include +# include +# include +# include + +# if GTEST_OS_WINDOWS +# include +# else +# include +# include +# endif // GTEST_OS_WINDOWS + +#endif // GTEST_HAS_DEATH_TEST + +#include "gtest/gtest-message.h" +#include "gtest/internal/gtest-string.h" + +// Indicates that this translation unit is part of Google Test's +// implementation. It must come before gtest-internal-inl.h is +// included, or there will be a compiler error. This trick is to +// prevent a user from accidentally including gtest-internal-inl.h in +// his code. +#define GTEST_IMPLEMENTATION_ 1 +#include "src/gtest-internal-inl.h" +#undef GTEST_IMPLEMENTATION_ + +namespace testing { + +// Constants. + +// The default death test style. +static const char kDefaultDeathTestStyle[] = "fast"; + +GTEST_DEFINE_string_( + death_test_style, + internal::StringFromGTestEnv("death_test_style", kDefaultDeathTestStyle), + "Indicates how to run a death test in a forked child process: " + "\"threadsafe\" (child process re-executes the test binary " + "from the beginning, running only the specific death test) or " + "\"fast\" (child process runs the death test immediately " + "after forking)."); + +GTEST_DEFINE_bool_( + death_test_use_fork, + internal::BoolFromGTestEnv("death_test_use_fork", false), + "Instructs to use fork()/_exit() instead of clone() in death tests. " + "Ignored and always uses fork() on POSIX systems where clone() is not " + "implemented. Useful when running under valgrind or similar tools if " + "those do not support clone(). Valgrind 3.3.1 will just fail if " + "it sees an unsupported combination of clone() flags. " + "It is not recommended to use this flag w/o valgrind though it will " + "work in 99% of the cases. Once valgrind is fixed, this flag will " + "most likely be removed."); + +namespace internal { +GTEST_DEFINE_string_( + internal_run_death_test, "", + "Indicates the file, line number, temporal index of " + "the single death test to run, and a file descriptor to " + "which a success code may be sent, all separated by " + "colons. This flag is specified if and only if the current " + "process is a sub-process launched for running a thread-safe " + "death test. FOR INTERNAL USE ONLY."); +} // namespace internal + +#if GTEST_HAS_DEATH_TEST + +// ExitedWithCode constructor. +ExitedWithCode::ExitedWithCode(int exit_code) : exit_code_(exit_code) { +} + +// ExitedWithCode function-call operator. +bool ExitedWithCode::operator()(int exit_status) const { +# if GTEST_OS_WINDOWS + + return exit_status == exit_code_; + +# else + + return WIFEXITED(exit_status) && WEXITSTATUS(exit_status) == exit_code_; + +# endif // GTEST_OS_WINDOWS +} + +# if !GTEST_OS_WINDOWS +// KilledBySignal constructor. +KilledBySignal::KilledBySignal(int signum) : signum_(signum) { +} + +// KilledBySignal function-call operator. +bool KilledBySignal::operator()(int exit_status) const { + return WIFSIGNALED(exit_status) && WTERMSIG(exit_status) == signum_; +} +# endif // !GTEST_OS_WINDOWS + +namespace internal { + +// Utilities needed for death tests. + +// Generates a textual description of a given exit code, in the format +// specified by wait(2). +static String ExitSummary(int exit_code) { + Message m; + +# if GTEST_OS_WINDOWS + + m << "Exited with exit status " << exit_code; + +# else + + if (WIFEXITED(exit_code)) { + m << "Exited with exit status " << WEXITSTATUS(exit_code); + } else if (WIFSIGNALED(exit_code)) { + m << "Terminated by signal " << WTERMSIG(exit_code); + } +# ifdef WCOREDUMP + if (WCOREDUMP(exit_code)) { + m << " (core dumped)"; + } +# endif +# endif // GTEST_OS_WINDOWS + + return m.GetString(); +} + +// Returns true if exit_status describes a process that was terminated +// by a signal, or exited normally with a nonzero exit code. +bool ExitedUnsuccessfully(int exit_status) { + return !ExitedWithCode(0)(exit_status); +} + +# if !GTEST_OS_WINDOWS +// Generates a textual failure message when a death test finds more than +// one thread running, or cannot determine the number of threads, prior +// to executing the given statement. It is the responsibility of the +// caller not to pass a thread_count of 1. +static String DeathTestThreadWarning(size_t thread_count) { + Message msg; + msg << "Death tests use fork(), which is unsafe particularly" + << " in a threaded context. For this test, " << GTEST_NAME_ << " "; + if (thread_count == 0) + msg << "couldn't detect the number of threads."; + else + msg << "detected " << thread_count << " threads."; + return msg.GetString(); +} +# endif // !GTEST_OS_WINDOWS + +// Flag characters for reporting a death test that did not die. +static const char kDeathTestLived = 'L'; +static const char kDeathTestReturned = 'R'; +static const char kDeathTestThrew = 'T'; +static const char kDeathTestInternalError = 'I'; + +// An enumeration describing all of the possible ways that a death test can +// conclude. DIED means that the process died while executing the test +// code; LIVED means that process lived beyond the end of the test code; +// RETURNED means that the test statement attempted to execute a return +// statement, which is not allowed; THREW means that the test statement +// returned control by throwing an exception. IN_PROGRESS means the test +// has not yet concluded. +// TODO(vladl@google.com): Unify names and possibly values for +// AbortReason, DeathTestOutcome, and flag characters above. +enum DeathTestOutcome { IN_PROGRESS, DIED, LIVED, RETURNED, THREW }; + +// Routine for aborting the program which is safe to call from an +// exec-style death test child process, in which case the error +// message is propagated back to the parent process. Otherwise, the +// message is simply printed to stderr. In either case, the program +// then exits with status 1. +void DeathTestAbort(const String& message) { + // On a POSIX system, this function may be called from a threadsafe-style + // death test child process, which operates on a very small stack. Use + // the heap for any additional non-minuscule memory requirements. + const InternalRunDeathTestFlag* const flag = + GetUnitTestImpl()->internal_run_death_test_flag(); + if (flag != NULL) { + FILE* parent = posix::FDOpen(flag->write_fd(), "w"); + fputc(kDeathTestInternalError, parent); + fprintf(parent, "%s", message.c_str()); + fflush(parent); + _exit(1); + } else { + fprintf(stderr, "%s", message.c_str()); + fflush(stderr); + posix::Abort(); + } +} + +// A replacement for CHECK that calls DeathTestAbort if the assertion +// fails. +# define GTEST_DEATH_TEST_CHECK_(expression) \ + do { \ + if (!::testing::internal::IsTrue(expression)) { \ + DeathTestAbort(::testing::internal::String::Format( \ + "CHECK failed: File %s, line %d: %s", \ + __FILE__, __LINE__, #expression)); \ + } \ + } while (::testing::internal::AlwaysFalse()) + +// This macro is similar to GTEST_DEATH_TEST_CHECK_, but it is meant for +// evaluating any system call that fulfills two conditions: it must return +// -1 on failure, and set errno to EINTR when it is interrupted and +// should be tried again. The macro expands to a loop that repeatedly +// evaluates the expression as long as it evaluates to -1 and sets +// errno to EINTR. If the expression evaluates to -1 but errno is +// something other than EINTR, DeathTestAbort is called. +# define GTEST_DEATH_TEST_CHECK_SYSCALL_(expression) \ + do { \ + int gtest_retval; \ + do { \ + gtest_retval = (expression); \ + } while (gtest_retval == -1 && errno == EINTR); \ + if (gtest_retval == -1) { \ + DeathTestAbort(::testing::internal::String::Format( \ + "CHECK failed: File %s, line %d: %s != -1", \ + __FILE__, __LINE__, #expression)); \ + } \ + } while (::testing::internal::AlwaysFalse()) + +// Returns the message describing the last system error in errno. +String GetLastErrnoDescription() { + return String(errno == 0 ? "" : posix::StrError(errno)); +} + +// This is called from a death test parent process to read a failure +// message from the death test child process and log it with the FATAL +// severity. On Windows, the message is read from a pipe handle. On other +// platforms, it is read from a file descriptor. +static void FailFromInternalError(int fd) { + Message error; + char buffer[256]; + int num_read; + + do { + while ((num_read = posix::Read(fd, buffer, 255)) > 0) { + buffer[num_read] = '\0'; + error << buffer; + } + } while (num_read == -1 && errno == EINTR); + + if (num_read == 0) { + GTEST_LOG_(FATAL) << error.GetString(); + } else { + const int last_error = errno; + GTEST_LOG_(FATAL) << "Error while reading death test internal: " + << GetLastErrnoDescription() << " [" << last_error << "]"; + } +} + +// Death test constructor. Increments the running death test count +// for the current test. +DeathTest::DeathTest() { + TestInfo* const info = GetUnitTestImpl()->current_test_info(); + if (info == NULL) { + DeathTestAbort("Cannot run a death test outside of a TEST or " + "TEST_F construct"); + } +} + +// Creates and returns a death test by dispatching to the current +// death test factory. +bool DeathTest::Create(const char* statement, const RE* regex, + const char* file, int line, DeathTest** test) { + return GetUnitTestImpl()->death_test_factory()->Create( + statement, regex, file, line, test); +} + +const char* DeathTest::LastMessage() { + return last_death_test_message_.c_str(); +} + +void DeathTest::set_last_death_test_message(const String& message) { + last_death_test_message_ = message; +} + +String DeathTest::last_death_test_message_; + +// Provides cross platform implementation for some death functionality. +class DeathTestImpl : public DeathTest { + protected: + DeathTestImpl(const char* a_statement, const RE* a_regex) + : statement_(a_statement), + regex_(a_regex), + spawned_(false), + status_(-1), + outcome_(IN_PROGRESS), + read_fd_(-1), + write_fd_(-1) {} + + // read_fd_ is expected to be closed and cleared by a derived class. + ~DeathTestImpl() { GTEST_DEATH_TEST_CHECK_(read_fd_ == -1); } + + void Abort(AbortReason reason); + virtual bool Passed(bool status_ok); + + const char* statement() const { return statement_; } + const RE* regex() const { return regex_; } + bool spawned() const { return spawned_; } + void set_spawned(bool is_spawned) { spawned_ = is_spawned; } + int status() const { return status_; } + void set_status(int a_status) { status_ = a_status; } + DeathTestOutcome outcome() const { return outcome_; } + void set_outcome(DeathTestOutcome an_outcome) { outcome_ = an_outcome; } + int read_fd() const { return read_fd_; } + void set_read_fd(int fd) { read_fd_ = fd; } + int write_fd() const { return write_fd_; } + void set_write_fd(int fd) { write_fd_ = fd; } + + // Called in the parent process only. Reads the result code of the death + // test child process via a pipe, interprets it to set the outcome_ + // member, and closes read_fd_. Outputs diagnostics and terminates in + // case of unexpected codes. + void ReadAndInterpretStatusByte(); + + private: + // The textual content of the code this object is testing. This class + // doesn't own this string and should not attempt to delete it. + const char* const statement_; + // The regular expression which test output must match. DeathTestImpl + // doesn't own this object and should not attempt to delete it. + const RE* const regex_; + // True if the death test child process has been successfully spawned. + bool spawned_; + // The exit status of the child process. + int status_; + // How the death test concluded. + DeathTestOutcome outcome_; + // Descriptor to the read end of the pipe to the child process. It is + // always -1 in the child process. The child keeps its write end of the + // pipe in write_fd_. + int read_fd_; + // Descriptor to the child's write end of the pipe to the parent process. + // It is always -1 in the parent process. The parent keeps its end of the + // pipe in read_fd_. + int write_fd_; +}; + +// Called in the parent process only. Reads the result code of the death +// test child process via a pipe, interprets it to set the outcome_ +// member, and closes read_fd_. Outputs diagnostics and terminates in +// case of unexpected codes. +void DeathTestImpl::ReadAndInterpretStatusByte() { + char flag; + int bytes_read; + + // The read() here blocks until data is available (signifying the + // failure of the death test) or until the pipe is closed (signifying + // its success), so it's okay to call this in the parent before + // the child process has exited. + do { + bytes_read = posix::Read(read_fd(), &flag, 1); + } while (bytes_read == -1 && errno == EINTR); + + if (bytes_read == 0) { + set_outcome(DIED); + } else if (bytes_read == 1) { + switch (flag) { + case kDeathTestReturned: + set_outcome(RETURNED); + break; + case kDeathTestThrew: + set_outcome(THREW); + break; + case kDeathTestLived: + set_outcome(LIVED); + break; + case kDeathTestInternalError: + FailFromInternalError(read_fd()); // Does not return. + break; + default: + GTEST_LOG_(FATAL) << "Death test child process reported " + << "unexpected status byte (" + << static_cast(flag) << ")"; + } + } else { + GTEST_LOG_(FATAL) << "Read from death test child process failed: " + << GetLastErrnoDescription(); + } + GTEST_DEATH_TEST_CHECK_SYSCALL_(posix::Close(read_fd())); + set_read_fd(-1); +} + +// Signals that the death test code which should have exited, didn't. +// Should be called only in a death test child process. +// Writes a status byte to the child's status file descriptor, then +// calls _exit(1). +void DeathTestImpl::Abort(AbortReason reason) { + // The parent process considers the death test to be a failure if + // it finds any data in our pipe. So, here we write a single flag byte + // to the pipe, then exit. + const char status_ch = + reason == TEST_DID_NOT_DIE ? kDeathTestLived : + reason == TEST_THREW_EXCEPTION ? kDeathTestThrew : kDeathTestReturned; + + GTEST_DEATH_TEST_CHECK_SYSCALL_(posix::Write(write_fd(), &status_ch, 1)); + // We are leaking the descriptor here because on some platforms (i.e., + // when built as Windows DLL), destructors of global objects will still + // run after calling _exit(). On such systems, write_fd_ will be + // indirectly closed from the destructor of UnitTestImpl, causing double + // close if it is also closed here. On debug configurations, double close + // may assert. As there are no in-process buffers to flush here, we are + // relying on the OS to close the descriptor after the process terminates + // when the destructors are not run. + _exit(1); // Exits w/o any normal exit hooks (we were supposed to crash) +} + +// Returns an indented copy of stderr output for a death test. +// This makes distinguishing death test output lines from regular log lines +// much easier. +static ::std::string FormatDeathTestOutput(const ::std::string& output) { + ::std::string ret; + for (size_t at = 0; ; ) { + const size_t line_end = output.find('\n', at); + ret += "[ DEATH ] "; + if (line_end == ::std::string::npos) { + ret += output.substr(at); + break; + } + ret += output.substr(at, line_end + 1 - at); + at = line_end + 1; + } + return ret; +} + +// Assesses the success or failure of a death test, using both private +// members which have previously been set, and one argument: +// +// Private data members: +// outcome: An enumeration describing how the death test +// concluded: DIED, LIVED, THREW, or RETURNED. The death test +// fails in the latter three cases. +// status: The exit status of the child process. On *nix, it is in the +// in the format specified by wait(2). On Windows, this is the +// value supplied to the ExitProcess() API or a numeric code +// of the exception that terminated the program. +// regex: A regular expression object to be applied to +// the test's captured standard error output; the death test +// fails if it does not match. +// +// Argument: +// status_ok: true if exit_status is acceptable in the context of +// this particular death test, which fails if it is false +// +// Returns true iff all of the above conditions are met. Otherwise, the +// first failing condition, in the order given above, is the one that is +// reported. Also sets the last death test message string. +bool DeathTestImpl::Passed(bool status_ok) { + if (!spawned()) + return false; + + const String error_message = GetCapturedStderr(); + + bool success = false; + Message buffer; + + buffer << "Death test: " << statement() << "\n"; + switch (outcome()) { + case LIVED: + buffer << " Result: failed to die.\n" + << " Error msg:\n" << FormatDeathTestOutput(error_message); + break; + case THREW: + buffer << " Result: threw an exception.\n" + << " Error msg:\n" << FormatDeathTestOutput(error_message); + break; + case RETURNED: + buffer << " Result: illegal return in test statement.\n" + << " Error msg:\n" << FormatDeathTestOutput(error_message); + break; + case DIED: + if (status_ok) { + const bool matched = RE::PartialMatch(error_message.c_str(), *regex()); + if (matched) { + success = true; + } else { + buffer << " Result: died but not with expected error.\n" + << " Expected: " << regex()->pattern() << "\n" + << "Actual msg:\n" << FormatDeathTestOutput(error_message); + } + } else { + buffer << " Result: died but not with expected exit code:\n" + << " " << ExitSummary(status()) << "\n" + << "Actual msg:\n" << FormatDeathTestOutput(error_message); + } + break; + case IN_PROGRESS: + default: + GTEST_LOG_(FATAL) + << "DeathTest::Passed somehow called before conclusion of test"; + } + + DeathTest::set_last_death_test_message(buffer.GetString()); + return success; +} + +# if GTEST_OS_WINDOWS +// WindowsDeathTest implements death tests on Windows. Due to the +// specifics of starting new processes on Windows, death tests there are +// always threadsafe, and Google Test considers the +// --gtest_death_test_style=fast setting to be equivalent to +// --gtest_death_test_style=threadsafe there. +// +// A few implementation notes: Like the Linux version, the Windows +// implementation uses pipes for child-to-parent communication. But due to +// the specifics of pipes on Windows, some extra steps are required: +// +// 1. The parent creates a communication pipe and stores handles to both +// ends of it. +// 2. The parent starts the child and provides it with the information +// necessary to acquire the handle to the write end of the pipe. +// 3. The child acquires the write end of the pipe and signals the parent +// using a Windows event. +// 4. Now the parent can release the write end of the pipe on its side. If +// this is done before step 3, the object's reference count goes down to +// 0 and it is destroyed, preventing the child from acquiring it. The +// parent now has to release it, or read operations on the read end of +// the pipe will not return when the child terminates. +// 5. The parent reads child's output through the pipe (outcome code and +// any possible error messages) from the pipe, and its stderr and then +// determines whether to fail the test. +// +// Note: to distinguish Win32 API calls from the local method and function +// calls, the former are explicitly resolved in the global namespace. +// +class WindowsDeathTest : public DeathTestImpl { + public: + WindowsDeathTest(const char* a_statement, + const RE* a_regex, + const char* file, + int line) + : DeathTestImpl(a_statement, a_regex), file_(file), line_(line) {} + + // All of these virtual functions are inherited from DeathTest. + virtual int Wait(); + virtual TestRole AssumeRole(); + + private: + // The name of the file in which the death test is located. + const char* const file_; + // The line number on which the death test is located. + const int line_; + // Handle to the write end of the pipe to the child process. + AutoHandle write_handle_; + // Child process handle. + AutoHandle child_handle_; + // Event the child process uses to signal the parent that it has + // acquired the handle to the write end of the pipe. After seeing this + // event the parent can release its own handles to make sure its + // ReadFile() calls return when the child terminates. + AutoHandle event_handle_; +}; + +// Waits for the child in a death test to exit, returning its exit +// status, or 0 if no child process exists. As a side effect, sets the +// outcome data member. +int WindowsDeathTest::Wait() { + if (!spawned()) + return 0; + + // Wait until the child either signals that it has acquired the write end + // of the pipe or it dies. + const HANDLE wait_handles[2] = { child_handle_.Get(), event_handle_.Get() }; + switch (::WaitForMultipleObjects(2, + wait_handles, + FALSE, // Waits for any of the handles. + INFINITE)) { + case WAIT_OBJECT_0: + case WAIT_OBJECT_0 + 1: + break; + default: + GTEST_DEATH_TEST_CHECK_(false); // Should not get here. + } + + // The child has acquired the write end of the pipe or exited. + // We release the handle on our side and continue. + write_handle_.Reset(); + event_handle_.Reset(); + + ReadAndInterpretStatusByte(); + + // Waits for the child process to exit if it haven't already. This + // returns immediately if the child has already exited, regardless of + // whether previous calls to WaitForMultipleObjects synchronized on this + // handle or not. + GTEST_DEATH_TEST_CHECK_( + WAIT_OBJECT_0 == ::WaitForSingleObject(child_handle_.Get(), + INFINITE)); + DWORD status_code; + GTEST_DEATH_TEST_CHECK_( + ::GetExitCodeProcess(child_handle_.Get(), &status_code) != FALSE); + child_handle_.Reset(); + set_status(static_cast(status_code)); + return status(); +} + +// The AssumeRole process for a Windows death test. It creates a child +// process with the same executable as the current process to run the +// death test. The child process is given the --gtest_filter and +// --gtest_internal_run_death_test flags such that it knows to run the +// current death test only. +DeathTest::TestRole WindowsDeathTest::AssumeRole() { + const UnitTestImpl* const impl = GetUnitTestImpl(); + const InternalRunDeathTestFlag* const flag = + impl->internal_run_death_test_flag(); + const TestInfo* const info = impl->current_test_info(); + const int death_test_index = info->result()->death_test_count(); + + if (flag != NULL) { + // ParseInternalRunDeathTestFlag() has performed all the necessary + // processing. + set_write_fd(flag->write_fd()); + return EXECUTE_TEST; + } + + // WindowsDeathTest uses an anonymous pipe to communicate results of + // a death test. + SECURITY_ATTRIBUTES handles_are_inheritable = { + sizeof(SECURITY_ATTRIBUTES), NULL, TRUE }; + HANDLE read_handle, write_handle; + GTEST_DEATH_TEST_CHECK_( + ::CreatePipe(&read_handle, &write_handle, &handles_are_inheritable, + 0) // Default buffer size. + != FALSE); + set_read_fd(::_open_osfhandle(reinterpret_cast(read_handle), + O_RDONLY)); + write_handle_.Reset(write_handle); + event_handle_.Reset(::CreateEvent( + &handles_are_inheritable, + TRUE, // The event will automatically reset to non-signaled state. + FALSE, // The initial state is non-signalled. + NULL)); // The even is unnamed. + GTEST_DEATH_TEST_CHECK_(event_handle_.Get() != NULL); + const String filter_flag = String::Format("--%s%s=%s.%s", + GTEST_FLAG_PREFIX_, kFilterFlag, + info->test_case_name(), + info->name()); + const String internal_flag = String::Format( + "--%s%s=%s|%d|%d|%u|%Iu|%Iu", + GTEST_FLAG_PREFIX_, + kInternalRunDeathTestFlag, + file_, line_, + death_test_index, + static_cast(::GetCurrentProcessId()), + // size_t has the same with as pointers on both 32-bit and 64-bit + // Windows platforms. + // See http://msdn.microsoft.com/en-us/library/tcxf1dw6.aspx. + reinterpret_cast(write_handle), + reinterpret_cast(event_handle_.Get())); + + char executable_path[_MAX_PATH + 1]; // NOLINT + GTEST_DEATH_TEST_CHECK_( + _MAX_PATH + 1 != ::GetModuleFileNameA(NULL, + executable_path, + _MAX_PATH)); + + String command_line = String::Format("%s %s \"%s\"", + ::GetCommandLineA(), + filter_flag.c_str(), + internal_flag.c_str()); + + DeathTest::set_last_death_test_message(""); + + CaptureStderr(); + // Flush the log buffers since the log streams are shared with the child. + FlushInfoLog(); + + // The child process will share the standard handles with the parent. + STARTUPINFOA startup_info; + memset(&startup_info, 0, sizeof(STARTUPINFO)); + startup_info.dwFlags = STARTF_USESTDHANDLES; + startup_info.hStdInput = ::GetStdHandle(STD_INPUT_HANDLE); + startup_info.hStdOutput = ::GetStdHandle(STD_OUTPUT_HANDLE); + startup_info.hStdError = ::GetStdHandle(STD_ERROR_HANDLE); + + PROCESS_INFORMATION process_info; + GTEST_DEATH_TEST_CHECK_(::CreateProcessA( + executable_path, + const_cast(command_line.c_str()), + NULL, // Retuned process handle is not inheritable. + NULL, // Retuned thread handle is not inheritable. + TRUE, // Child inherits all inheritable handles (for write_handle_). + 0x0, // Default creation flags. + NULL, // Inherit the parent's environment. + UnitTest::GetInstance()->original_working_dir(), + &startup_info, + &process_info) != FALSE); + child_handle_.Reset(process_info.hProcess); + ::CloseHandle(process_info.hThread); + set_spawned(true); + return OVERSEE_TEST; +} +# else // We are not on Windows. + +// ForkingDeathTest provides implementations for most of the abstract +// methods of the DeathTest interface. Only the AssumeRole method is +// left undefined. +class ForkingDeathTest : public DeathTestImpl { + public: + ForkingDeathTest(const char* statement, const RE* regex); + + // All of these virtual functions are inherited from DeathTest. + virtual int Wait(); + + protected: + void set_child_pid(pid_t child_pid) { child_pid_ = child_pid; } + + private: + // PID of child process during death test; 0 in the child process itself. + pid_t child_pid_; +}; + +// Constructs a ForkingDeathTest. +ForkingDeathTest::ForkingDeathTest(const char* a_statement, const RE* a_regex) + : DeathTestImpl(a_statement, a_regex), + child_pid_(-1) {} + +// Waits for the child in a death test to exit, returning its exit +// status, or 0 if no child process exists. As a side effect, sets the +// outcome data member. +int ForkingDeathTest::Wait() { + if (!spawned()) + return 0; + + ReadAndInterpretStatusByte(); + + int status_value; + GTEST_DEATH_TEST_CHECK_SYSCALL_(waitpid(child_pid_, &status_value, 0)); + set_status(status_value); + return status_value; +} + +// A concrete death test class that forks, then immediately runs the test +// in the child process. +class NoExecDeathTest : public ForkingDeathTest { + public: + NoExecDeathTest(const char* a_statement, const RE* a_regex) : + ForkingDeathTest(a_statement, a_regex) { } + virtual TestRole AssumeRole(); +}; + +// The AssumeRole process for a fork-and-run death test. It implements a +// straightforward fork, with a simple pipe to transmit the status byte. +DeathTest::TestRole NoExecDeathTest::AssumeRole() { + const size_t thread_count = GetThreadCount(); + if (thread_count != 1) { + GTEST_LOG_(WARNING) << DeathTestThreadWarning(thread_count); + } + + int pipe_fd[2]; + GTEST_DEATH_TEST_CHECK_(pipe(pipe_fd) != -1); + + DeathTest::set_last_death_test_message(""); + CaptureStderr(); + // When we fork the process below, the log file buffers are copied, but the + // file descriptors are shared. We flush all log files here so that closing + // the file descriptors in the child process doesn't throw off the + // synchronization between descriptors and buffers in the parent process. + // This is as close to the fork as possible to avoid a race condition in case + // there are multiple threads running before the death test, and another + // thread writes to the log file. + FlushInfoLog(); + + const pid_t child_pid = fork(); + GTEST_DEATH_TEST_CHECK_(child_pid != -1); + set_child_pid(child_pid); + if (child_pid == 0) { + GTEST_DEATH_TEST_CHECK_SYSCALL_(close(pipe_fd[0])); + set_write_fd(pipe_fd[1]); + // Redirects all logging to stderr in the child process to prevent + // concurrent writes to the log files. We capture stderr in the parent + // process and append the child process' output to a log. + LogToStderr(); + // Event forwarding to the listeners of event listener API mush be shut + // down in death test subprocesses. + GetUnitTestImpl()->listeners()->SuppressEventForwarding(); + return EXECUTE_TEST; + } else { + GTEST_DEATH_TEST_CHECK_SYSCALL_(close(pipe_fd[1])); + set_read_fd(pipe_fd[0]); + set_spawned(true); + return OVERSEE_TEST; + } +} + +// A concrete death test class that forks and re-executes the main +// program from the beginning, with command-line flags set that cause +// only this specific death test to be run. +class ExecDeathTest : public ForkingDeathTest { + public: + ExecDeathTest(const char* a_statement, const RE* a_regex, + const char* file, int line) : + ForkingDeathTest(a_statement, a_regex), file_(file), line_(line) { } + virtual TestRole AssumeRole(); + private: + // The name of the file in which the death test is located. + const char* const file_; + // The line number on which the death test is located. + const int line_; +}; + +// Utility class for accumulating command-line arguments. +class Arguments { + public: + Arguments() { + args_.push_back(NULL); + } + + ~Arguments() { + for (std::vector::iterator i = args_.begin(); i != args_.end(); + ++i) { + free(*i); + } + } + void AddArgument(const char* argument) { + args_.insert(args_.end() - 1, posix::StrDup(argument)); + } + + template + void AddArguments(const ::std::vector& arguments) { + for (typename ::std::vector::const_iterator i = arguments.begin(); + i != arguments.end(); + ++i) { + args_.insert(args_.end() - 1, posix::StrDup(i->c_str())); + } + } + char* const* Argv() { + return &args_[0]; + } + private: + std::vector args_; +}; + +// A struct that encompasses the arguments to the child process of a +// threadsafe-style death test process. +struct ExecDeathTestArgs { + char* const* argv; // Command-line arguments for the child's call to exec + int close_fd; // File descriptor to close; the read end of a pipe +}; + +# if GTEST_OS_MAC +inline char** GetEnviron() { + // When Google Test is built as a framework on MacOS X, the environ variable + // is unavailable. Apple's documentation (man environ) recommends using + // _NSGetEnviron() instead. + return *_NSGetEnviron(); +} +# else +// Some POSIX platforms expect you to declare environ. extern "C" makes +// it reside in the global namespace. +extern "C" char** environ; +inline char** GetEnviron() { return environ; } +# endif // GTEST_OS_MAC + +// The main function for a threadsafe-style death test child process. +// This function is called in a clone()-ed process and thus must avoid +// any potentially unsafe operations like malloc or libc functions. +static int ExecDeathTestChildMain(void* child_arg) { + ExecDeathTestArgs* const args = static_cast(child_arg); + GTEST_DEATH_TEST_CHECK_SYSCALL_(close(args->close_fd)); + + // We need to execute the test program in the same environment where + // it was originally invoked. Therefore we change to the original + // working directory first. + const char* const original_dir = + UnitTest::GetInstance()->original_working_dir(); + // We can safely call chdir() as it's a direct system call. + if (chdir(original_dir) != 0) { + DeathTestAbort(String::Format("chdir(\"%s\") failed: %s", + original_dir, + GetLastErrnoDescription().c_str())); + return EXIT_FAILURE; + } + + // We can safely call execve() as it's a direct system call. We + // cannot use execvp() as it's a libc function and thus potentially + // unsafe. Since execve() doesn't search the PATH, the user must + // invoke the test program via a valid path that contains at least + // one path separator. + execve(args->argv[0], args->argv, GetEnviron()); + DeathTestAbort(String::Format("execve(%s, ...) in %s failed: %s", + args->argv[0], + original_dir, + GetLastErrnoDescription().c_str())); + return EXIT_FAILURE; +} + +// Two utility routines that together determine the direction the stack +// grows. +// This could be accomplished more elegantly by a single recursive +// function, but we want to guard against the unlikely possibility of +// a smart compiler optimizing the recursion away. +// +// GTEST_NO_INLINE_ is required to prevent GCC 4.6 from inlining +// StackLowerThanAddress into StackGrowsDown, which then doesn't give +// correct answer. +bool StackLowerThanAddress(const void* ptr) GTEST_NO_INLINE_; +bool StackLowerThanAddress(const void* ptr) { + int dummy; + return &dummy < ptr; +} + +bool StackGrowsDown() { + int dummy; + return StackLowerThanAddress(&dummy); +} + +// A threadsafe implementation of fork(2) for threadsafe-style death tests +// that uses clone(2). It dies with an error message if anything goes +// wrong. +static pid_t ExecDeathTestFork(char* const* argv, int close_fd) { + ExecDeathTestArgs args = { argv, close_fd }; + pid_t child_pid = -1; + +# if GTEST_HAS_CLONE + const bool use_fork = GTEST_FLAG(death_test_use_fork); + + if (!use_fork) { + static const bool stack_grows_down = StackGrowsDown(); + const size_t stack_size = getpagesize(); + // MMAP_ANONYMOUS is not defined on Mac, so we use MAP_ANON instead. + void* const stack = mmap(NULL, stack_size, PROT_READ | PROT_WRITE, + MAP_ANON | MAP_PRIVATE, -1, 0); + GTEST_DEATH_TEST_CHECK_(stack != MAP_FAILED); + void* const stack_top = + static_cast(stack) + (stack_grows_down ? stack_size : 0); + + child_pid = clone(&ExecDeathTestChildMain, stack_top, SIGCHLD, &args); + + GTEST_DEATH_TEST_CHECK_(munmap(stack, stack_size) != -1); + } +# else + const bool use_fork = true; +# endif // GTEST_HAS_CLONE + + if (use_fork && (child_pid = fork()) == 0) { + ExecDeathTestChildMain(&args); + _exit(0); + } + + GTEST_DEATH_TEST_CHECK_(child_pid != -1); + return child_pid; +} + +// The AssumeRole process for a fork-and-exec death test. It re-executes the +// main program from the beginning, setting the --gtest_filter +// and --gtest_internal_run_death_test flags to cause only the current +// death test to be re-run. +DeathTest::TestRole ExecDeathTest::AssumeRole() { + const UnitTestImpl* const impl = GetUnitTestImpl(); + const InternalRunDeathTestFlag* const flag = + impl->internal_run_death_test_flag(); + const TestInfo* const info = impl->current_test_info(); + const int death_test_index = info->result()->death_test_count(); + + if (flag != NULL) { + set_write_fd(flag->write_fd()); + return EXECUTE_TEST; + } + + int pipe_fd[2]; + GTEST_DEATH_TEST_CHECK_(pipe(pipe_fd) != -1); + // Clear the close-on-exec flag on the write end of the pipe, lest + // it be closed when the child process does an exec: + GTEST_DEATH_TEST_CHECK_(fcntl(pipe_fd[1], F_SETFD, 0) != -1); + + const String filter_flag = + String::Format("--%s%s=%s.%s", + GTEST_FLAG_PREFIX_, kFilterFlag, + info->test_case_name(), info->name()); + const String internal_flag = + String::Format("--%s%s=%s|%d|%d|%d", + GTEST_FLAG_PREFIX_, kInternalRunDeathTestFlag, + file_, line_, death_test_index, pipe_fd[1]); + Arguments args; + args.AddArguments(GetArgvs()); + args.AddArgument(filter_flag.c_str()); + args.AddArgument(internal_flag.c_str()); + + DeathTest::set_last_death_test_message(""); + + CaptureStderr(); + // See the comment in NoExecDeathTest::AssumeRole for why the next line + // is necessary. + FlushInfoLog(); + + const pid_t child_pid = ExecDeathTestFork(args.Argv(), pipe_fd[0]); + GTEST_DEATH_TEST_CHECK_SYSCALL_(close(pipe_fd[1])); + set_child_pid(child_pid); + set_read_fd(pipe_fd[0]); + set_spawned(true); + return OVERSEE_TEST; +} + +# endif // !GTEST_OS_WINDOWS + +// Creates a concrete DeathTest-derived class that depends on the +// --gtest_death_test_style flag, and sets the pointer pointed to +// by the "test" argument to its address. If the test should be +// skipped, sets that pointer to NULL. Returns true, unless the +// flag is set to an invalid value. +bool DefaultDeathTestFactory::Create(const char* statement, const RE* regex, + const char* file, int line, + DeathTest** test) { + UnitTestImpl* const impl = GetUnitTestImpl(); + const InternalRunDeathTestFlag* const flag = + impl->internal_run_death_test_flag(); + const int death_test_index = impl->current_test_info() + ->increment_death_test_count(); + + if (flag != NULL) { + if (death_test_index > flag->index()) { + DeathTest::set_last_death_test_message(String::Format( + "Death test count (%d) somehow exceeded expected maximum (%d)", + death_test_index, flag->index())); + return false; + } + + if (!(flag->file() == file && flag->line() == line && + flag->index() == death_test_index)) { + *test = NULL; + return true; + } + } + +# if GTEST_OS_WINDOWS + + if (GTEST_FLAG(death_test_style) == "threadsafe" || + GTEST_FLAG(death_test_style) == "fast") { + *test = new WindowsDeathTest(statement, regex, file, line); + } + +# else + + if (GTEST_FLAG(death_test_style) == "threadsafe") { + *test = new ExecDeathTest(statement, regex, file, line); + } else if (GTEST_FLAG(death_test_style) == "fast") { + *test = new NoExecDeathTest(statement, regex); + } + +# endif // GTEST_OS_WINDOWS + + else { // NOLINT - this is more readable than unbalanced brackets inside #if. + DeathTest::set_last_death_test_message(String::Format( + "Unknown death test style \"%s\" encountered", + GTEST_FLAG(death_test_style).c_str())); + return false; + } + + return true; +} + +// Splits a given string on a given delimiter, populating a given +// vector with the fields. GTEST_HAS_DEATH_TEST implies that we have +// ::std::string, so we can use it here. +static void SplitString(const ::std::string& str, char delimiter, + ::std::vector< ::std::string>* dest) { + ::std::vector< ::std::string> parsed; + ::std::string::size_type pos = 0; + while (::testing::internal::AlwaysTrue()) { + const ::std::string::size_type colon = str.find(delimiter, pos); + if (colon == ::std::string::npos) { + parsed.push_back(str.substr(pos)); + break; + } else { + parsed.push_back(str.substr(pos, colon - pos)); + pos = colon + 1; + } + } + dest->swap(parsed); +} + +# if GTEST_OS_WINDOWS +// Recreates the pipe and event handles from the provided parameters, +// signals the event, and returns a file descriptor wrapped around the pipe +// handle. This function is called in the child process only. +int GetStatusFileDescriptor(unsigned int parent_process_id, + size_t write_handle_as_size_t, + size_t event_handle_as_size_t) { + AutoHandle parent_process_handle(::OpenProcess(PROCESS_DUP_HANDLE, + FALSE, // Non-inheritable. + parent_process_id)); + if (parent_process_handle.Get() == INVALID_HANDLE_VALUE) { + DeathTestAbort(String::Format("Unable to open parent process %u", + parent_process_id)); + } + + // TODO(vladl@google.com): Replace the following check with a + // compile-time assertion when available. + GTEST_CHECK_(sizeof(HANDLE) <= sizeof(size_t)); + + const HANDLE write_handle = + reinterpret_cast(write_handle_as_size_t); + HANDLE dup_write_handle; + + // The newly initialized handle is accessible only in in the parent + // process. To obtain one accessible within the child, we need to use + // DuplicateHandle. + if (!::DuplicateHandle(parent_process_handle.Get(), write_handle, + ::GetCurrentProcess(), &dup_write_handle, + 0x0, // Requested privileges ignored since + // DUPLICATE_SAME_ACCESS is used. + FALSE, // Request non-inheritable handler. + DUPLICATE_SAME_ACCESS)) { + DeathTestAbort(String::Format( + "Unable to duplicate the pipe handle %Iu from the parent process %u", + write_handle_as_size_t, parent_process_id)); + } + + const HANDLE event_handle = reinterpret_cast(event_handle_as_size_t); + HANDLE dup_event_handle; + + if (!::DuplicateHandle(parent_process_handle.Get(), event_handle, + ::GetCurrentProcess(), &dup_event_handle, + 0x0, + FALSE, + DUPLICATE_SAME_ACCESS)) { + DeathTestAbort(String::Format( + "Unable to duplicate the event handle %Iu from the parent process %u", + event_handle_as_size_t, parent_process_id)); + } + + const int write_fd = + ::_open_osfhandle(reinterpret_cast(dup_write_handle), O_APPEND); + if (write_fd == -1) { + DeathTestAbort(String::Format( + "Unable to convert pipe handle %Iu to a file descriptor", + write_handle_as_size_t)); + } + + // Signals the parent that the write end of the pipe has been acquired + // so the parent can release its own write end. + ::SetEvent(dup_event_handle); + + return write_fd; +} +# endif // GTEST_OS_WINDOWS + +// Returns a newly created InternalRunDeathTestFlag object with fields +// initialized from the GTEST_FLAG(internal_run_death_test) flag if +// the flag is specified; otherwise returns NULL. +InternalRunDeathTestFlag* ParseInternalRunDeathTestFlag() { + if (GTEST_FLAG(internal_run_death_test) == "") return NULL; + + // GTEST_HAS_DEATH_TEST implies that we have ::std::string, so we + // can use it here. + int line = -1; + int index = -1; + ::std::vector< ::std::string> fields; + SplitString(GTEST_FLAG(internal_run_death_test).c_str(), '|', &fields); + int write_fd = -1; + +# if GTEST_OS_WINDOWS + + unsigned int parent_process_id = 0; + size_t write_handle_as_size_t = 0; + size_t event_handle_as_size_t = 0; + + if (fields.size() != 6 + || !ParseNaturalNumber(fields[1], &line) + || !ParseNaturalNumber(fields[2], &index) + || !ParseNaturalNumber(fields[3], &parent_process_id) + || !ParseNaturalNumber(fields[4], &write_handle_as_size_t) + || !ParseNaturalNumber(fields[5], &event_handle_as_size_t)) { + DeathTestAbort(String::Format( + "Bad --gtest_internal_run_death_test flag: %s", + GTEST_FLAG(internal_run_death_test).c_str())); + } + write_fd = GetStatusFileDescriptor(parent_process_id, + write_handle_as_size_t, + event_handle_as_size_t); +# else + + if (fields.size() != 4 + || !ParseNaturalNumber(fields[1], &line) + || !ParseNaturalNumber(fields[2], &index) + || !ParseNaturalNumber(fields[3], &write_fd)) { + DeathTestAbort(String::Format( + "Bad --gtest_internal_run_death_test flag: %s", + GTEST_FLAG(internal_run_death_test).c_str())); + } + +# endif // GTEST_OS_WINDOWS + + return new InternalRunDeathTestFlag(fields[0], line, index, write_fd); +} + +} // namespace internal + +#endif // GTEST_HAS_DEATH_TEST + +} // namespace testing diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-filepath.cc b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-filepath.cc new file mode 100644 index 0000000000..2aa913b596 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-filepath.cc @@ -0,0 +1,380 @@ +// Copyright 2008, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Authors: keith.ray@gmail.com (Keith Ray) + +#include "gtest/internal/gtest-filepath.h" +#include "gtest/internal/gtest-port.h" + +#include + +#if GTEST_OS_WINDOWS_MOBILE +# include +#elif GTEST_OS_WINDOWS +# include +# include +#elif GTEST_OS_SYMBIAN || GTEST_OS_NACL +// Symbian OpenC and NaCl have PATH_MAX in sys/syslimits.h +# include +#else +# include +# include // Some Linux distributions define PATH_MAX here. +#endif // GTEST_OS_WINDOWS_MOBILE + +#if GTEST_OS_WINDOWS +# define GTEST_PATH_MAX_ _MAX_PATH +#elif defined(PATH_MAX) +# define GTEST_PATH_MAX_ PATH_MAX +#elif defined(_XOPEN_PATH_MAX) +# define GTEST_PATH_MAX_ _XOPEN_PATH_MAX +#else +# define GTEST_PATH_MAX_ _POSIX_PATH_MAX +#endif // GTEST_OS_WINDOWS + +#include "gtest/internal/gtest-string.h" + +namespace testing { +namespace internal { + +#if GTEST_OS_WINDOWS +// On Windows, '\\' is the standard path separator, but many tools and the +// Windows API also accept '/' as an alternate path separator. Unless otherwise +// noted, a file path can contain either kind of path separators, or a mixture +// of them. +const char kPathSeparator = '\\'; +const char kAlternatePathSeparator = '/'; +const char kPathSeparatorString[] = "\\"; +const char kAlternatePathSeparatorString[] = "/"; +# if GTEST_OS_WINDOWS_MOBILE +// Windows CE doesn't have a current directory. You should not use +// the current directory in tests on Windows CE, but this at least +// provides a reasonable fallback. +const char kCurrentDirectoryString[] = "\\"; +// Windows CE doesn't define INVALID_FILE_ATTRIBUTES +const DWORD kInvalidFileAttributes = 0xffffffff; +# else +const char kCurrentDirectoryString[] = ".\\"; +# endif // GTEST_OS_WINDOWS_MOBILE +#else +const char kPathSeparator = '/'; +const char kPathSeparatorString[] = "/"; +const char kCurrentDirectoryString[] = "./"; +#endif // GTEST_OS_WINDOWS + +// Returns whether the given character is a valid path separator. +static bool IsPathSeparator(char c) { +#if GTEST_HAS_ALT_PATH_SEP_ + return (c == kPathSeparator) || (c == kAlternatePathSeparator); +#else + return c == kPathSeparator; +#endif +} + +// Returns the current working directory, or "" if unsuccessful. +FilePath FilePath::GetCurrentDir() { +#if GTEST_OS_WINDOWS_MOBILE + // Windows CE doesn't have a current directory, so we just return + // something reasonable. + return FilePath(kCurrentDirectoryString); +#elif GTEST_OS_WINDOWS + char cwd[GTEST_PATH_MAX_ + 1] = { '\0' }; + return FilePath(_getcwd(cwd, sizeof(cwd)) == NULL ? "" : cwd); +#else + char cwd[GTEST_PATH_MAX_ + 1] = { '\0' }; + return FilePath(getcwd(cwd, sizeof(cwd)) == NULL ? "" : cwd); +#endif // GTEST_OS_WINDOWS_MOBILE +} + +// Returns a copy of the FilePath with the case-insensitive extension removed. +// Example: FilePath("dir/file.exe").RemoveExtension("EXE") returns +// FilePath("dir/file"). If a case-insensitive extension is not +// found, returns a copy of the original FilePath. +FilePath FilePath::RemoveExtension(const char* extension) const { + String dot_extension(String::Format(".%s", extension)); + if (pathname_.EndsWithCaseInsensitive(dot_extension.c_str())) { + return FilePath(String(pathname_.c_str(), pathname_.length() - 4)); + } + return *this; +} + +// Returns a pointer to the last occurence of a valid path separator in +// the FilePath. On Windows, for example, both '/' and '\' are valid path +// separators. Returns NULL if no path separator was found. +const char* FilePath::FindLastPathSeparator() const { + const char* const last_sep = strrchr(c_str(), kPathSeparator); +#if GTEST_HAS_ALT_PATH_SEP_ + const char* const last_alt_sep = strrchr(c_str(), kAlternatePathSeparator); + // Comparing two pointers of which only one is NULL is undefined. + if (last_alt_sep != NULL && + (last_sep == NULL || last_alt_sep > last_sep)) { + return last_alt_sep; + } +#endif + return last_sep; +} + +// Returns a copy of the FilePath with the directory part removed. +// Example: FilePath("path/to/file").RemoveDirectoryName() returns +// FilePath("file"). If there is no directory part ("just_a_file"), it returns +// the FilePath unmodified. If there is no file part ("just_a_dir/") it +// returns an empty FilePath (""). +// On Windows platform, '\' is the path separator, otherwise it is '/'. +FilePath FilePath::RemoveDirectoryName() const { + const char* const last_sep = FindLastPathSeparator(); + return last_sep ? FilePath(String(last_sep + 1)) : *this; +} + +// RemoveFileName returns the directory path with the filename removed. +// Example: FilePath("path/to/file").RemoveFileName() returns "path/to/". +// If the FilePath is "a_file" or "/a_file", RemoveFileName returns +// FilePath("./") or, on Windows, FilePath(".\\"). If the filepath does +// not have a file, like "just/a/dir/", it returns the FilePath unmodified. +// On Windows platform, '\' is the path separator, otherwise it is '/'. +FilePath FilePath::RemoveFileName() const { + const char* const last_sep = FindLastPathSeparator(); + String dir; + if (last_sep) { + dir = String(c_str(), last_sep + 1 - c_str()); + } else { + dir = kCurrentDirectoryString; + } + return FilePath(dir); +} + +// Helper functions for naming files in a directory for xml output. + +// Given directory = "dir", base_name = "test", number = 0, +// extension = "xml", returns "dir/test.xml". If number is greater +// than zero (e.g., 12), returns "dir/test_12.xml". +// On Windows platform, uses \ as the separator rather than /. +FilePath FilePath::MakeFileName(const FilePath& directory, + const FilePath& base_name, + int number, + const char* extension) { + String file; + if (number == 0) { + file = String::Format("%s.%s", base_name.c_str(), extension); + } else { + file = String::Format("%s_%d.%s", base_name.c_str(), number, extension); + } + return ConcatPaths(directory, FilePath(file)); +} + +// Given directory = "dir", relative_path = "test.xml", returns "dir/test.xml". +// On Windows, uses \ as the separator rather than /. +FilePath FilePath::ConcatPaths(const FilePath& directory, + const FilePath& relative_path) { + if (directory.IsEmpty()) + return relative_path; + const FilePath dir(directory.RemoveTrailingPathSeparator()); + return FilePath(String::Format("%s%c%s", dir.c_str(), kPathSeparator, + relative_path.c_str())); +} + +// Returns true if pathname describes something findable in the file-system, +// either a file, directory, or whatever. +bool FilePath::FileOrDirectoryExists() const { +#if GTEST_OS_WINDOWS_MOBILE + LPCWSTR unicode = String::AnsiToUtf16(pathname_.c_str()); + const DWORD attributes = GetFileAttributes(unicode); + delete [] unicode; + return attributes != kInvalidFileAttributes; +#else + posix::StatStruct file_stat; + return posix::Stat(pathname_.c_str(), &file_stat) == 0; +#endif // GTEST_OS_WINDOWS_MOBILE +} + +// Returns true if pathname describes a directory in the file-system +// that exists. +bool FilePath::DirectoryExists() const { + bool result = false; +#if GTEST_OS_WINDOWS + // Don't strip off trailing separator if path is a root directory on + // Windows (like "C:\\"). + const FilePath& path(IsRootDirectory() ? *this : + RemoveTrailingPathSeparator()); +#else + const FilePath& path(*this); +#endif + +#if GTEST_OS_WINDOWS_MOBILE + LPCWSTR unicode = String::AnsiToUtf16(path.c_str()); + const DWORD attributes = GetFileAttributes(unicode); + delete [] unicode; + if ((attributes != kInvalidFileAttributes) && + (attributes & FILE_ATTRIBUTE_DIRECTORY)) { + result = true; + } +#else + posix::StatStruct file_stat; + result = posix::Stat(path.c_str(), &file_stat) == 0 && + posix::IsDir(file_stat); +#endif // GTEST_OS_WINDOWS_MOBILE + + return result; +} + +// Returns true if pathname describes a root directory. (Windows has one +// root directory per disk drive.) +bool FilePath::IsRootDirectory() const { +#if GTEST_OS_WINDOWS + // TODO(wan@google.com): on Windows a network share like + // \\server\share can be a root directory, although it cannot be the + // current directory. Handle this properly. + return pathname_.length() == 3 && IsAbsolutePath(); +#else + return pathname_.length() == 1 && IsPathSeparator(pathname_.c_str()[0]); +#endif +} + +// Returns true if pathname describes an absolute path. +bool FilePath::IsAbsolutePath() const { + const char* const name = pathname_.c_str(); +#if GTEST_OS_WINDOWS + return pathname_.length() >= 3 && + ((name[0] >= 'a' && name[0] <= 'z') || + (name[0] >= 'A' && name[0] <= 'Z')) && + name[1] == ':' && + IsPathSeparator(name[2]); +#else + return IsPathSeparator(name[0]); +#endif +} + +// Returns a pathname for a file that does not currently exist. The pathname +// will be directory/base_name.extension or +// directory/base_name_.extension if directory/base_name.extension +// already exists. The number will be incremented until a pathname is found +// that does not already exist. +// Examples: 'dir/foo_test.xml' or 'dir/foo_test_1.xml'. +// There could be a race condition if two or more processes are calling this +// function at the same time -- they could both pick the same filename. +FilePath FilePath::GenerateUniqueFileName(const FilePath& directory, + const FilePath& base_name, + const char* extension) { + FilePath full_pathname; + int number = 0; + do { + full_pathname.Set(MakeFileName(directory, base_name, number++, extension)); + } while (full_pathname.FileOrDirectoryExists()); + return full_pathname; +} + +// Returns true if FilePath ends with a path separator, which indicates that +// it is intended to represent a directory. Returns false otherwise. +// This does NOT check that a directory (or file) actually exists. +bool FilePath::IsDirectory() const { + return !pathname_.empty() && + IsPathSeparator(pathname_.c_str()[pathname_.length() - 1]); +} + +// Create directories so that path exists. Returns true if successful or if +// the directories already exist; returns false if unable to create directories +// for any reason. +bool FilePath::CreateDirectoriesRecursively() const { + if (!this->IsDirectory()) { + return false; + } + + if (pathname_.length() == 0 || this->DirectoryExists()) { + return true; + } + + const FilePath parent(this->RemoveTrailingPathSeparator().RemoveFileName()); + return parent.CreateDirectoriesRecursively() && this->CreateFolder(); +} + +// Create the directory so that path exists. Returns true if successful or +// if the directory already exists; returns false if unable to create the +// directory for any reason, including if the parent directory does not +// exist. Not named "CreateDirectory" because that's a macro on Windows. +bool FilePath::CreateFolder() const { +#if GTEST_OS_WINDOWS_MOBILE + FilePath removed_sep(this->RemoveTrailingPathSeparator()); + LPCWSTR unicode = String::AnsiToUtf16(removed_sep.c_str()); + int result = CreateDirectory(unicode, NULL) ? 0 : -1; + delete [] unicode; +#elif GTEST_OS_WINDOWS + int result = _mkdir(pathname_.c_str()); +#else + int result = mkdir(pathname_.c_str(), 0777); +#endif // GTEST_OS_WINDOWS_MOBILE + + if (result == -1) { + return this->DirectoryExists(); // An error is OK if the directory exists. + } + return true; // No error. +} + +// If input name has a trailing separator character, remove it and return the +// name, otherwise return the name string unmodified. +// On Windows platform, uses \ as the separator, other platforms use /. +FilePath FilePath::RemoveTrailingPathSeparator() const { + return IsDirectory() + ? FilePath(String(pathname_.c_str(), pathname_.length() - 1)) + : *this; +} + +// Removes any redundant separators that might be in the pathname. +// For example, "bar///foo" becomes "bar/foo". Does not eliminate other +// redundancies that might be in a pathname involving "." or "..". +// TODO(wan@google.com): handle Windows network shares (e.g. \\server\share). +void FilePath::Normalize() { + if (pathname_.c_str() == NULL) { + pathname_ = ""; + return; + } + const char* src = pathname_.c_str(); + char* const dest = new char[pathname_.length() + 1]; + char* dest_ptr = dest; + memset(dest_ptr, 0, pathname_.length() + 1); + + while (*src != '\0') { + *dest_ptr = *src; + if (!IsPathSeparator(*src)) { + src++; + } else { +#if GTEST_HAS_ALT_PATH_SEP_ + if (*dest_ptr == kAlternatePathSeparator) { + *dest_ptr = kPathSeparator; + } +#endif + while (IsPathSeparator(*src)) + src++; + } + dest_ptr++; + } + *dest_ptr = '\0'; + pathname_ = dest; + delete[] dest; +} + +} // namespace internal +} // namespace testing diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-internal-inl.h b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-internal-inl.h new file mode 100644 index 0000000000..8b88538e55 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-internal-inl.h @@ -0,0 +1,1038 @@ +// Copyright 2005, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +// Utility functions and classes used by the Google C++ testing framework. +// +// Author: wan@google.com (Zhanyong Wan) +// +// This file contains purely Google Test's internal implementation. Please +// DO NOT #INCLUDE IT IN A USER PROGRAM. + +#ifndef GTEST_SRC_GTEST_INTERNAL_INL_H_ +#define GTEST_SRC_GTEST_INTERNAL_INL_H_ + +// GTEST_IMPLEMENTATION_ is defined to 1 iff the current translation unit is +// part of Google Test's implementation; otherwise it's undefined. +#if !GTEST_IMPLEMENTATION_ +// A user is trying to include this from his code - just say no. +# error "gtest-internal-inl.h is part of Google Test's internal implementation." +# error "It must not be included except by Google Test itself." +#endif // GTEST_IMPLEMENTATION_ + +#ifndef _WIN32_WCE +# include +#endif // !_WIN32_WCE +#include +#include // For strtoll/_strtoul64/malloc/free. +#include // For memmove. + +#include +#include +#include + +#include "gtest/internal/gtest-port.h" + +#if GTEST_OS_WINDOWS +# include // NOLINT +#endif // GTEST_OS_WINDOWS + +#include "gtest/gtest.h" // NOLINT +#include "gtest/gtest-spi.h" + +namespace testing { + +// Declares the flags. +// +// We don't want the users to modify this flag in the code, but want +// Google Test's own unit tests to be able to access it. Therefore we +// declare it here as opposed to in gtest.h. +GTEST_DECLARE_bool_(death_test_use_fork); + +namespace internal { + +// The value of GetTestTypeId() as seen from within the Google Test +// library. This is solely for testing GetTestTypeId(). +GTEST_API_ extern const TypeId kTestTypeIdInGoogleTest; + +// Names of the flags (needed for parsing Google Test flags). +const char kAlsoRunDisabledTestsFlag[] = "also_run_disabled_tests"; +const char kBreakOnFailureFlag[] = "break_on_failure"; +const char kCatchExceptionsFlag[] = "catch_exceptions"; +const char kColorFlag[] = "color"; +const char kFilterFlag[] = "filter"; +const char kListTestsFlag[] = "list_tests"; +const char kOutputFlag[] = "output"; +const char kPrintTimeFlag[] = "print_time"; +const char kRandomSeedFlag[] = "random_seed"; +const char kRepeatFlag[] = "repeat"; +const char kShuffleFlag[] = "shuffle"; +const char kStackTraceDepthFlag[] = "stack_trace_depth"; +const char kStreamResultToFlag[] = "stream_result_to"; +const char kThrowOnFailureFlag[] = "throw_on_failure"; + +// A valid random seed must be in [1, kMaxRandomSeed]. +const int kMaxRandomSeed = 99999; + +// g_help_flag is true iff the --help flag or an equivalent form is +// specified on the command line. +GTEST_API_ extern bool g_help_flag; + +// Returns the current time in milliseconds. +GTEST_API_ TimeInMillis GetTimeInMillis(); + +// Returns true iff Google Test should use colors in the output. +GTEST_API_ bool ShouldUseColor(bool stdout_is_tty); + +// Formats the given time in milliseconds as seconds. +GTEST_API_ std::string FormatTimeInMillisAsSeconds(TimeInMillis ms); + +// Parses a string for an Int32 flag, in the form of "--flag=value". +// +// On success, stores the value of the flag in *value, and returns +// true. On failure, returns false without changing *value. +GTEST_API_ bool ParseInt32Flag( + const char* str, const char* flag, Int32* value); + +// Returns a random seed in range [1, kMaxRandomSeed] based on the +// given --gtest_random_seed flag value. +inline int GetRandomSeedFromFlag(Int32 random_seed_flag) { + const unsigned int raw_seed = (random_seed_flag == 0) ? + static_cast(GetTimeInMillis()) : + static_cast(random_seed_flag); + + // Normalizes the actual seed to range [1, kMaxRandomSeed] such that + // it's easy to type. + const int normalized_seed = + static_cast((raw_seed - 1U) % + static_cast(kMaxRandomSeed)) + 1; + return normalized_seed; +} + +// Returns the first valid random seed after 'seed'. The behavior is +// undefined if 'seed' is invalid. The seed after kMaxRandomSeed is +// considered to be 1. +inline int GetNextRandomSeed(int seed) { + GTEST_CHECK_(1 <= seed && seed <= kMaxRandomSeed) + << "Invalid random seed " << seed << " - must be in [1, " + << kMaxRandomSeed << "]."; + const int next_seed = seed + 1; + return (next_seed > kMaxRandomSeed) ? 1 : next_seed; +} + +// This class saves the values of all Google Test flags in its c'tor, and +// restores them in its d'tor. +class GTestFlagSaver { + public: + // The c'tor. + GTestFlagSaver() { + also_run_disabled_tests_ = GTEST_FLAG(also_run_disabled_tests); + break_on_failure_ = GTEST_FLAG(break_on_failure); + catch_exceptions_ = GTEST_FLAG(catch_exceptions); + color_ = GTEST_FLAG(color); + death_test_style_ = GTEST_FLAG(death_test_style); + death_test_use_fork_ = GTEST_FLAG(death_test_use_fork); + filter_ = GTEST_FLAG(filter); + internal_run_death_test_ = GTEST_FLAG(internal_run_death_test); + list_tests_ = GTEST_FLAG(list_tests); + output_ = GTEST_FLAG(output); + print_time_ = GTEST_FLAG(print_time); + random_seed_ = GTEST_FLAG(random_seed); + repeat_ = GTEST_FLAG(repeat); + shuffle_ = GTEST_FLAG(shuffle); + stack_trace_depth_ = GTEST_FLAG(stack_trace_depth); + stream_result_to_ = GTEST_FLAG(stream_result_to); + throw_on_failure_ = GTEST_FLAG(throw_on_failure); + } + + // The d'tor is not virtual. DO NOT INHERIT FROM THIS CLASS. + ~GTestFlagSaver() { + GTEST_FLAG(also_run_disabled_tests) = also_run_disabled_tests_; + GTEST_FLAG(break_on_failure) = break_on_failure_; + GTEST_FLAG(catch_exceptions) = catch_exceptions_; + GTEST_FLAG(color) = color_; + GTEST_FLAG(death_test_style) = death_test_style_; + GTEST_FLAG(death_test_use_fork) = death_test_use_fork_; + GTEST_FLAG(filter) = filter_; + GTEST_FLAG(internal_run_death_test) = internal_run_death_test_; + GTEST_FLAG(list_tests) = list_tests_; + GTEST_FLAG(output) = output_; + GTEST_FLAG(print_time) = print_time_; + GTEST_FLAG(random_seed) = random_seed_; + GTEST_FLAG(repeat) = repeat_; + GTEST_FLAG(shuffle) = shuffle_; + GTEST_FLAG(stack_trace_depth) = stack_trace_depth_; + GTEST_FLAG(stream_result_to) = stream_result_to_; + GTEST_FLAG(throw_on_failure) = throw_on_failure_; + } + private: + // Fields for saving the original values of flags. + bool also_run_disabled_tests_; + bool break_on_failure_; + bool catch_exceptions_; + String color_; + String death_test_style_; + bool death_test_use_fork_; + String filter_; + String internal_run_death_test_; + bool list_tests_; + String output_; + bool print_time_; + bool pretty_; + internal::Int32 random_seed_; + internal::Int32 repeat_; + bool shuffle_; + internal::Int32 stack_trace_depth_; + String stream_result_to_; + bool throw_on_failure_; +} GTEST_ATTRIBUTE_UNUSED_; + +// Converts a Unicode code point to a narrow string in UTF-8 encoding. +// code_point parameter is of type UInt32 because wchar_t may not be +// wide enough to contain a code point. +// The output buffer str must containt at least 32 characters. +// The function returns the address of the output buffer. +// If the code_point is not a valid Unicode code point +// (i.e. outside of Unicode range U+0 to U+10FFFF) it will be output +// as '(Invalid Unicode 0xXXXXXXXX)'. +GTEST_API_ char* CodePointToUtf8(UInt32 code_point, char* str); + +// Converts a wide string to a narrow string in UTF-8 encoding. +// The wide string is assumed to have the following encoding: +// UTF-16 if sizeof(wchar_t) == 2 (on Windows, Cygwin, Symbian OS) +// UTF-32 if sizeof(wchar_t) == 4 (on Linux) +// Parameter str points to a null-terminated wide string. +// Parameter num_chars may additionally limit the number +// of wchar_t characters processed. -1 is used when the entire string +// should be processed. +// If the string contains code points that are not valid Unicode code points +// (i.e. outside of Unicode range U+0 to U+10FFFF) they will be output +// as '(Invalid Unicode 0xXXXXXXXX)'. If the string is in UTF16 encoding +// and contains invalid UTF-16 surrogate pairs, values in those pairs +// will be encoded as individual Unicode characters from Basic Normal Plane. +GTEST_API_ String WideStringToUtf8(const wchar_t* str, int num_chars); + +// Reads the GTEST_SHARD_STATUS_FILE environment variable, and creates the file +// if the variable is present. If a file already exists at this location, this +// function will write over it. If the variable is present, but the file cannot +// be created, prints an error and exits. +void WriteToShardStatusFileIfNeeded(); + +// Checks whether sharding is enabled by examining the relevant +// environment variable values. If the variables are present, +// but inconsistent (e.g., shard_index >= total_shards), prints +// an error and exits. If in_subprocess_for_death_test, sharding is +// disabled because it must only be applied to the original test +// process. Otherwise, we could filter out death tests we intended to execute. +GTEST_API_ bool ShouldShard(const char* total_shards_str, + const char* shard_index_str, + bool in_subprocess_for_death_test); + +// Parses the environment variable var as an Int32. If it is unset, +// returns default_val. If it is not an Int32, prints an error and +// and aborts. +GTEST_API_ Int32 Int32FromEnvOrDie(const char* env_var, Int32 default_val); + +// Given the total number of shards, the shard index, and the test id, +// returns true iff the test should be run on this shard. The test id is +// some arbitrary but unique non-negative integer assigned to each test +// method. Assumes that 0 <= shard_index < total_shards. +GTEST_API_ bool ShouldRunTestOnShard( + int total_shards, int shard_index, int test_id); + +// STL container utilities. + +// Returns the number of elements in the given container that satisfy +// the given predicate. +template +inline int CountIf(const Container& c, Predicate predicate) { + // Implemented as an explicit loop since std::count_if() in libCstd on + // Solaris has a non-standard signature. + int count = 0; + for (typename Container::const_iterator it = c.begin(); it != c.end(); ++it) { + if (predicate(*it)) + ++count; + } + return count; +} + +// Applies a function/functor to each element in the container. +template +void ForEach(const Container& c, Functor functor) { + std::for_each(c.begin(), c.end(), functor); +} + +// Returns the i-th element of the vector, or default_value if i is not +// in range [0, v.size()). +template +inline E GetElementOr(const std::vector& v, int i, E default_value) { + return (i < 0 || i >= static_cast(v.size())) ? default_value : v[i]; +} + +// Performs an in-place shuffle of a range of the vector's elements. +// 'begin' and 'end' are element indices as an STL-style range; +// i.e. [begin, end) are shuffled, where 'end' == size() means to +// shuffle to the end of the vector. +template +void ShuffleRange(internal::Random* random, int begin, int end, + std::vector* v) { + const int size = static_cast(v->size()); + GTEST_CHECK_(0 <= begin && begin <= size) + << "Invalid shuffle range start " << begin << ": must be in range [0, " + << size << "]."; + GTEST_CHECK_(begin <= end && end <= size) + << "Invalid shuffle range finish " << end << ": must be in range [" + << begin << ", " << size << "]."; + + // Fisher-Yates shuffle, from + // http://en.wikipedia.org/wiki/Fisher-Yates_shuffle + for (int range_width = end - begin; range_width >= 2; range_width--) { + const int last_in_range = begin + range_width - 1; + const int selected = begin + random->Generate(range_width); + std::swap((*v)[selected], (*v)[last_in_range]); + } +} + +// Performs an in-place shuffle of the vector's elements. +template +inline void Shuffle(internal::Random* random, std::vector* v) { + ShuffleRange(random, 0, static_cast(v->size()), v); +} + +// A function for deleting an object. Handy for being used as a +// functor. +template +static void Delete(T* x) { + delete x; +} + +// A predicate that checks the key of a TestProperty against a known key. +// +// TestPropertyKeyIs is copyable. +class TestPropertyKeyIs { + public: + // Constructor. + // + // TestPropertyKeyIs has NO default constructor. + explicit TestPropertyKeyIs(const char* key) + : key_(key) {} + + // Returns true iff the test name of test property matches on key_. + bool operator()(const TestProperty& test_property) const { + return String(test_property.key()).Compare(key_) == 0; + } + + private: + String key_; +}; + +// Class UnitTestOptions. +// +// This class contains functions for processing options the user +// specifies when running the tests. It has only static members. +// +// In most cases, the user can specify an option using either an +// environment variable or a command line flag. E.g. you can set the +// test filter using either GTEST_FILTER or --gtest_filter. If both +// the variable and the flag are present, the latter overrides the +// former. +class GTEST_API_ UnitTestOptions { + public: + // Functions for processing the gtest_output flag. + + // Returns the output format, or "" for normal printed output. + static String GetOutputFormat(); + + // Returns the absolute path of the requested output file, or the + // default (test_detail.xml in the original working directory) if + // none was explicitly specified. + static String GetAbsolutePathToOutputFile(); + + // Functions for processing the gtest_filter flag. + + // Returns true iff the wildcard pattern matches the string. The + // first ':' or '\0' character in pattern marks the end of it. + // + // This recursive algorithm isn't very efficient, but is clear and + // works well enough for matching test names, which are short. + static bool PatternMatchesString(const char *pattern, const char *str); + + // Returns true iff the user-specified filter matches the test case + // name and the test name. + static bool FilterMatchesTest(const String &test_case_name, + const String &test_name); + +#if GTEST_OS_WINDOWS + // Function for supporting the gtest_catch_exception flag. + + // Returns EXCEPTION_EXECUTE_HANDLER if Google Test should handle the + // given SEH exception, or EXCEPTION_CONTINUE_SEARCH otherwise. + // This function is useful as an __except condition. + static int GTestShouldProcessSEH(DWORD exception_code); +#endif // GTEST_OS_WINDOWS + + // Returns true if "name" matches the ':' separated list of glob-style + // filters in "filter". + static bool MatchesFilter(const String& name, const char* filter); +}; + +// Returns the current application's name, removing directory path if that +// is present. Used by UnitTestOptions::GetOutputFile. +GTEST_API_ FilePath GetCurrentExecutableName(); + +// The role interface for getting the OS stack trace as a string. +class OsStackTraceGetterInterface { + public: + OsStackTraceGetterInterface() {} + virtual ~OsStackTraceGetterInterface() {} + + // Returns the current OS stack trace as a String. Parameters: + // + // max_depth - the maximum number of stack frames to be included + // in the trace. + // skip_count - the number of top frames to be skipped; doesn't count + // against max_depth. + virtual String CurrentStackTrace(int max_depth, int skip_count) = 0; + + // UponLeavingGTest() should be called immediately before Google Test calls + // user code. It saves some information about the current stack that + // CurrentStackTrace() will use to find and hide Google Test stack frames. + virtual void UponLeavingGTest() = 0; + + private: + GTEST_DISALLOW_COPY_AND_ASSIGN_(OsStackTraceGetterInterface); +}; + +// A working implementation of the OsStackTraceGetterInterface interface. +class OsStackTraceGetter : public OsStackTraceGetterInterface { + public: + OsStackTraceGetter() : caller_frame_(NULL) {} + virtual String CurrentStackTrace(int max_depth, int skip_count); + virtual void UponLeavingGTest(); + + // This string is inserted in place of stack frames that are part of + // Google Test's implementation. + static const char* const kElidedFramesMarker; + + private: + Mutex mutex_; // protects all internal state + + // We save the stack frame below the frame that calls user code. + // We do this because the address of the frame immediately below + // the user code changes between the call to UponLeavingGTest() + // and any calls to CurrentStackTrace() from within the user code. + void* caller_frame_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(OsStackTraceGetter); +}; + +// Information about a Google Test trace point. +struct TraceInfo { + const char* file; + int line; + String message; +}; + +// This is the default global test part result reporter used in UnitTestImpl. +// This class should only be used by UnitTestImpl. +class DefaultGlobalTestPartResultReporter + : public TestPartResultReporterInterface { + public: + explicit DefaultGlobalTestPartResultReporter(UnitTestImpl* unit_test); + // Implements the TestPartResultReporterInterface. Reports the test part + // result in the current test. + virtual void ReportTestPartResult(const TestPartResult& result); + + private: + UnitTestImpl* const unit_test_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultGlobalTestPartResultReporter); +}; + +// This is the default per thread test part result reporter used in +// UnitTestImpl. This class should only be used by UnitTestImpl. +class DefaultPerThreadTestPartResultReporter + : public TestPartResultReporterInterface { + public: + explicit DefaultPerThreadTestPartResultReporter(UnitTestImpl* unit_test); + // Implements the TestPartResultReporterInterface. The implementation just + // delegates to the current global test part result reporter of *unit_test_. + virtual void ReportTestPartResult(const TestPartResult& result); + + private: + UnitTestImpl* const unit_test_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultPerThreadTestPartResultReporter); +}; + +// The private implementation of the UnitTest class. We don't protect +// the methods under a mutex, as this class is not accessible by a +// user and the UnitTest class that delegates work to this class does +// proper locking. +class GTEST_API_ UnitTestImpl { + public: + explicit UnitTestImpl(UnitTest* parent); + virtual ~UnitTestImpl(); + + // There are two different ways to register your own TestPartResultReporter. + // You can register your own repoter to listen either only for test results + // from the current thread or for results from all threads. + // By default, each per-thread test result repoter just passes a new + // TestPartResult to the global test result reporter, which registers the + // test part result for the currently running test. + + // Returns the global test part result reporter. + TestPartResultReporterInterface* GetGlobalTestPartResultReporter(); + + // Sets the global test part result reporter. + void SetGlobalTestPartResultReporter( + TestPartResultReporterInterface* reporter); + + // Returns the test part result reporter for the current thread. + TestPartResultReporterInterface* GetTestPartResultReporterForCurrentThread(); + + // Sets the test part result reporter for the current thread. + void SetTestPartResultReporterForCurrentThread( + TestPartResultReporterInterface* reporter); + + // Gets the number of successful test cases. + int successful_test_case_count() const; + + // Gets the number of failed test cases. + int failed_test_case_count() const; + + // Gets the number of all test cases. + int total_test_case_count() const; + + // Gets the number of all test cases that contain at least one test + // that should run. + int test_case_to_run_count() const; + + // Gets the number of successful tests. + int successful_test_count() const; + + // Gets the number of failed tests. + int failed_test_count() const; + + // Gets the number of disabled tests. + int disabled_test_count() const; + + // Gets the number of all tests. + int total_test_count() const; + + // Gets the number of tests that should run. + int test_to_run_count() const; + + // Gets the elapsed time, in milliseconds. + TimeInMillis elapsed_time() const { return elapsed_time_; } + + // Returns true iff the unit test passed (i.e. all test cases passed). + bool Passed() const { return !Failed(); } + + // Returns true iff the unit test failed (i.e. some test case failed + // or something outside of all tests failed). + bool Failed() const { + return failed_test_case_count() > 0 || ad_hoc_test_result()->Failed(); + } + + // Gets the i-th test case among all the test cases. i can range from 0 to + // total_test_case_count() - 1. If i is not in that range, returns NULL. + const TestCase* GetTestCase(int i) const { + const int index = GetElementOr(test_case_indices_, i, -1); + return index < 0 ? NULL : test_cases_[i]; + } + + // Gets the i-th test case among all the test cases. i can range from 0 to + // total_test_case_count() - 1. If i is not in that range, returns NULL. + TestCase* GetMutableTestCase(int i) { + const int index = GetElementOr(test_case_indices_, i, -1); + return index < 0 ? NULL : test_cases_[index]; + } + + // Provides access to the event listener list. + TestEventListeners* listeners() { return &listeners_; } + + // Returns the TestResult for the test that's currently running, or + // the TestResult for the ad hoc test if no test is running. + TestResult* current_test_result(); + + // Returns the TestResult for the ad hoc test. + const TestResult* ad_hoc_test_result() const { return &ad_hoc_test_result_; } + + // Sets the OS stack trace getter. + // + // Does nothing if the input and the current OS stack trace getter + // are the same; otherwise, deletes the old getter and makes the + // input the current getter. + void set_os_stack_trace_getter(OsStackTraceGetterInterface* getter); + + // Returns the current OS stack trace getter if it is not NULL; + // otherwise, creates an OsStackTraceGetter, makes it the current + // getter, and returns it. + OsStackTraceGetterInterface* os_stack_trace_getter(); + + // Returns the current OS stack trace as a String. + // + // The maximum number of stack frames to be included is specified by + // the gtest_stack_trace_depth flag. The skip_count parameter + // specifies the number of top frames to be skipped, which doesn't + // count against the number of frames to be included. + // + // For example, if Foo() calls Bar(), which in turn calls + // CurrentOsStackTraceExceptTop(1), Foo() will be included in the + // trace but Bar() and CurrentOsStackTraceExceptTop() won't. + String CurrentOsStackTraceExceptTop(int skip_count); + + // Finds and returns a TestCase with the given name. If one doesn't + // exist, creates one and returns it. + // + // Arguments: + // + // test_case_name: name of the test case + // type_param: the name of the test's type parameter, or NULL if + // this is not a typed or a type-parameterized test. + // set_up_tc: pointer to the function that sets up the test case + // tear_down_tc: pointer to the function that tears down the test case + TestCase* GetTestCase(const char* test_case_name, + const char* type_param, + Test::SetUpTestCaseFunc set_up_tc, + Test::TearDownTestCaseFunc tear_down_tc); + + // Adds a TestInfo to the unit test. + // + // Arguments: + // + // set_up_tc: pointer to the function that sets up the test case + // tear_down_tc: pointer to the function that tears down the test case + // test_info: the TestInfo object + void AddTestInfo(Test::SetUpTestCaseFunc set_up_tc, + Test::TearDownTestCaseFunc tear_down_tc, + TestInfo* test_info) { + // In order to support thread-safe death tests, we need to + // remember the original working directory when the test program + // was first invoked. We cannot do this in RUN_ALL_TESTS(), as + // the user may have changed the current directory before calling + // RUN_ALL_TESTS(). Therefore we capture the current directory in + // AddTestInfo(), which is called to register a TEST or TEST_F + // before main() is reached. + if (original_working_dir_.IsEmpty()) { + original_working_dir_.Set(FilePath::GetCurrentDir()); + GTEST_CHECK_(!original_working_dir_.IsEmpty()) + << "Failed to get the current working directory."; + } + + GetTestCase(test_info->test_case_name(), + test_info->type_param(), + set_up_tc, + tear_down_tc)->AddTestInfo(test_info); + } + +#if GTEST_HAS_PARAM_TEST + // Returns ParameterizedTestCaseRegistry object used to keep track of + // value-parameterized tests and instantiate and register them. + internal::ParameterizedTestCaseRegistry& parameterized_test_registry() { + return parameterized_test_registry_; + } +#endif // GTEST_HAS_PARAM_TEST + + // Sets the TestCase object for the test that's currently running. + void set_current_test_case(TestCase* a_current_test_case) { + current_test_case_ = a_current_test_case; + } + + // Sets the TestInfo object for the test that's currently running. If + // current_test_info is NULL, the assertion results will be stored in + // ad_hoc_test_result_. + void set_current_test_info(TestInfo* a_current_test_info) { + current_test_info_ = a_current_test_info; + } + + // Registers all parameterized tests defined using TEST_P and + // INSTANTIATE_TEST_CASE_P, creating regular tests for each test/parameter + // combination. This method can be called more then once; it has guards + // protecting from registering the tests more then once. If + // value-parameterized tests are disabled, RegisterParameterizedTests is + // present but does nothing. + void RegisterParameterizedTests(); + + // Runs all tests in this UnitTest object, prints the result, and + // returns true if all tests are successful. If any exception is + // thrown during a test, this test is considered to be failed, but + // the rest of the tests will still be run. + bool RunAllTests(); + + // Clears the results of all tests, except the ad hoc tests. + void ClearNonAdHocTestResult() { + ForEach(test_cases_, TestCase::ClearTestCaseResult); + } + + // Clears the results of ad-hoc test assertions. + void ClearAdHocTestResult() { + ad_hoc_test_result_.Clear(); + } + + enum ReactionToSharding { + HONOR_SHARDING_PROTOCOL, + IGNORE_SHARDING_PROTOCOL + }; + + // Matches the full name of each test against the user-specified + // filter to decide whether the test should run, then records the + // result in each TestCase and TestInfo object. + // If shard_tests == HONOR_SHARDING_PROTOCOL, further filters tests + // based on sharding variables in the environment. + // Returns the number of tests that should run. + int FilterTests(ReactionToSharding shard_tests); + + // Prints the names of the tests matching the user-specified filter flag. + void ListTestsMatchingFilter(); + + const TestCase* current_test_case() const { return current_test_case_; } + TestInfo* current_test_info() { return current_test_info_; } + const TestInfo* current_test_info() const { return current_test_info_; } + + // Returns the vector of environments that need to be set-up/torn-down + // before/after the tests are run. + std::vector& environments() { return environments_; } + + // Getters for the per-thread Google Test trace stack. + std::vector& gtest_trace_stack() { + return *(gtest_trace_stack_.pointer()); + } + const std::vector& gtest_trace_stack() const { + return gtest_trace_stack_.get(); + } + +#if GTEST_HAS_DEATH_TEST + void InitDeathTestSubprocessControlInfo() { + internal_run_death_test_flag_.reset(ParseInternalRunDeathTestFlag()); + } + // Returns a pointer to the parsed --gtest_internal_run_death_test + // flag, or NULL if that flag was not specified. + // This information is useful only in a death test child process. + // Must not be called before a call to InitGoogleTest. + const InternalRunDeathTestFlag* internal_run_death_test_flag() const { + return internal_run_death_test_flag_.get(); + } + + // Returns a pointer to the current death test factory. + internal::DeathTestFactory* death_test_factory() { + return death_test_factory_.get(); + } + + void SuppressTestEventsIfInSubprocess(); + + friend class ReplaceDeathTestFactory; +#endif // GTEST_HAS_DEATH_TEST + + // Initializes the event listener performing XML output as specified by + // UnitTestOptions. Must not be called before InitGoogleTest. + void ConfigureXmlOutput(); + +#if GTEST_CAN_STREAM_RESULTS_ + // Initializes the event listener for streaming test results to a socket. + // Must not be called before InitGoogleTest. + void ConfigureStreamingOutput(); +#endif + + // Performs initialization dependent upon flag values obtained in + // ParseGoogleTestFlagsOnly. Is called from InitGoogleTest after the call to + // ParseGoogleTestFlagsOnly. In case a user neglects to call InitGoogleTest + // this function is also called from RunAllTests. Since this function can be + // called more than once, it has to be idempotent. + void PostFlagParsingInit(); + + // Gets the random seed used at the start of the current test iteration. + int random_seed() const { return random_seed_; } + + // Gets the random number generator. + internal::Random* random() { return &random_; } + + // Shuffles all test cases, and the tests within each test case, + // making sure that death tests are still run first. + void ShuffleTests(); + + // Restores the test cases and tests to their order before the first shuffle. + void UnshuffleTests(); + + // Returns the value of GTEST_FLAG(catch_exceptions) at the moment + // UnitTest::Run() starts. + bool catch_exceptions() const { return catch_exceptions_; } + + private: + friend class ::testing::UnitTest; + + // Used by UnitTest::Run() to capture the state of + // GTEST_FLAG(catch_exceptions) at the moment it starts. + void set_catch_exceptions(bool value) { catch_exceptions_ = value; } + + // The UnitTest object that owns this implementation object. + UnitTest* const parent_; + + // The working directory when the first TEST() or TEST_F() was + // executed. + internal::FilePath original_working_dir_; + + // The default test part result reporters. + DefaultGlobalTestPartResultReporter default_global_test_part_result_reporter_; + DefaultPerThreadTestPartResultReporter + default_per_thread_test_part_result_reporter_; + + // Points to (but doesn't own) the global test part result reporter. + TestPartResultReporterInterface* global_test_part_result_repoter_; + + // Protects read and write access to global_test_part_result_reporter_. + internal::Mutex global_test_part_result_reporter_mutex_; + + // Points to (but doesn't own) the per-thread test part result reporter. + internal::ThreadLocal + per_thread_test_part_result_reporter_; + + // The vector of environments that need to be set-up/torn-down + // before/after the tests are run. + std::vector environments_; + + // The vector of TestCases in their original order. It owns the + // elements in the vector. + std::vector test_cases_; + + // Provides a level of indirection for the test case list to allow + // easy shuffling and restoring the test case order. The i-th + // element of this vector is the index of the i-th test case in the + // shuffled order. + std::vector test_case_indices_; + +#if GTEST_HAS_PARAM_TEST + // ParameterizedTestRegistry object used to register value-parameterized + // tests. + internal::ParameterizedTestCaseRegistry parameterized_test_registry_; + + // Indicates whether RegisterParameterizedTests() has been called already. + bool parameterized_tests_registered_; +#endif // GTEST_HAS_PARAM_TEST + + // Index of the last death test case registered. Initially -1. + int last_death_test_case_; + + // This points to the TestCase for the currently running test. It + // changes as Google Test goes through one test case after another. + // When no test is running, this is set to NULL and Google Test + // stores assertion results in ad_hoc_test_result_. Initially NULL. + TestCase* current_test_case_; + + // This points to the TestInfo for the currently running test. It + // changes as Google Test goes through one test after another. When + // no test is running, this is set to NULL and Google Test stores + // assertion results in ad_hoc_test_result_. Initially NULL. + TestInfo* current_test_info_; + + // Normally, a user only writes assertions inside a TEST or TEST_F, + // or inside a function called by a TEST or TEST_F. Since Google + // Test keeps track of which test is current running, it can + // associate such an assertion with the test it belongs to. + // + // If an assertion is encountered when no TEST or TEST_F is running, + // Google Test attributes the assertion result to an imaginary "ad hoc" + // test, and records the result in ad_hoc_test_result_. + TestResult ad_hoc_test_result_; + + // The list of event listeners that can be used to track events inside + // Google Test. + TestEventListeners listeners_; + + // The OS stack trace getter. Will be deleted when the UnitTest + // object is destructed. By default, an OsStackTraceGetter is used, + // but the user can set this field to use a custom getter if that is + // desired. + OsStackTraceGetterInterface* os_stack_trace_getter_; + + // True iff PostFlagParsingInit() has been called. + bool post_flag_parse_init_performed_; + + // The random number seed used at the beginning of the test run. + int random_seed_; + + // Our random number generator. + internal::Random random_; + + // How long the test took to run, in milliseconds. + TimeInMillis elapsed_time_; + +#if GTEST_HAS_DEATH_TEST + // The decomposed components of the gtest_internal_run_death_test flag, + // parsed when RUN_ALL_TESTS is called. + internal::scoped_ptr internal_run_death_test_flag_; + internal::scoped_ptr death_test_factory_; +#endif // GTEST_HAS_DEATH_TEST + + // A per-thread stack of traces created by the SCOPED_TRACE() macro. + internal::ThreadLocal > gtest_trace_stack_; + + // The value of GTEST_FLAG(catch_exceptions) at the moment RunAllTests() + // starts. + bool catch_exceptions_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(UnitTestImpl); +}; // class UnitTestImpl + +// Convenience function for accessing the global UnitTest +// implementation object. +inline UnitTestImpl* GetUnitTestImpl() { + return UnitTest::GetInstance()->impl(); +} + +#if GTEST_USES_SIMPLE_RE + +// Internal helper functions for implementing the simple regular +// expression matcher. +GTEST_API_ bool IsInSet(char ch, const char* str); +GTEST_API_ bool IsAsciiDigit(char ch); +GTEST_API_ bool IsAsciiPunct(char ch); +GTEST_API_ bool IsRepeat(char ch); +GTEST_API_ bool IsAsciiWhiteSpace(char ch); +GTEST_API_ bool IsAsciiWordChar(char ch); +GTEST_API_ bool IsValidEscape(char ch); +GTEST_API_ bool AtomMatchesChar(bool escaped, char pattern, char ch); +GTEST_API_ bool ValidateRegex(const char* regex); +GTEST_API_ bool MatchRegexAtHead(const char* regex, const char* str); +GTEST_API_ bool MatchRepetitionAndRegexAtHead( + bool escaped, char ch, char repeat, const char* regex, const char* str); +GTEST_API_ bool MatchRegexAnywhere(const char* regex, const char* str); + +#endif // GTEST_USES_SIMPLE_RE + +// Parses the command line for Google Test flags, without initializing +// other parts of Google Test. +GTEST_API_ void ParseGoogleTestFlagsOnly(int* argc, char** argv); +GTEST_API_ void ParseGoogleTestFlagsOnly(int* argc, wchar_t** argv); + +#if GTEST_HAS_DEATH_TEST + +// Returns the message describing the last system error, regardless of the +// platform. +GTEST_API_ String GetLastErrnoDescription(); + +# if GTEST_OS_WINDOWS +// Provides leak-safe Windows kernel handle ownership. +class AutoHandle { + public: + AutoHandle() : handle_(INVALID_HANDLE_VALUE) {} + explicit AutoHandle(HANDLE handle) : handle_(handle) {} + + ~AutoHandle() { Reset(); } + + HANDLE Get() const { return handle_; } + void Reset() { Reset(INVALID_HANDLE_VALUE); } + void Reset(HANDLE handle) { + if (handle != handle_) { + if (handle_ != INVALID_HANDLE_VALUE) + ::CloseHandle(handle_); + handle_ = handle; + } + } + + private: + HANDLE handle_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(AutoHandle); +}; +# endif // GTEST_OS_WINDOWS + +// Attempts to parse a string into a positive integer pointed to by the +// number parameter. Returns true if that is possible. +// GTEST_HAS_DEATH_TEST implies that we have ::std::string, so we can use +// it here. +template +bool ParseNaturalNumber(const ::std::string& str, Integer* number) { + // Fail fast if the given string does not begin with a digit; + // this bypasses strtoXXX's "optional leading whitespace and plus + // or minus sign" semantics, which are undesirable here. + if (str.empty() || !IsDigit(str[0])) { + return false; + } + errno = 0; + + char* end; + // BiggestConvertible is the largest integer type that system-provided + // string-to-number conversion routines can return. + +# if GTEST_OS_WINDOWS && !defined(__GNUC__) + + // MSVC and C++ Builder define __int64 instead of the standard long long. + typedef unsigned __int64 BiggestConvertible; + const BiggestConvertible parsed = _strtoui64(str.c_str(), &end, 10); + +# else + + typedef unsigned long long BiggestConvertible; // NOLINT + const BiggestConvertible parsed = strtoull(str.c_str(), &end, 10); + +# endif // GTEST_OS_WINDOWS && !defined(__GNUC__) + + const bool parse_success = *end == '\0' && errno == 0; + + // TODO(vladl@google.com): Convert this to compile time assertion when it is + // available. + GTEST_CHECK_(sizeof(Integer) <= sizeof(parsed)); + + const Integer result = static_cast(parsed); + if (parse_success && static_cast(result) == parsed) { + *number = result; + return true; + } + return false; +} +#endif // GTEST_HAS_DEATH_TEST + +// TestResult contains some private methods that should be hidden from +// Google Test user but are required for testing. This class allow our tests +// to access them. +// +// This class is supplied only for the purpose of testing Google Test's own +// constructs. Do not use it in user tests, either directly or indirectly. +class TestResultAccessor { + public: + static void RecordProperty(TestResult* test_result, + const TestProperty& property) { + test_result->RecordProperty(property); + } + + static void ClearTestPartResults(TestResult* test_result) { + test_result->ClearTestPartResults(); + } + + static const std::vector& test_part_results( + const TestResult& test_result) { + return test_result.test_part_results(); + } +}; + +} // namespace internal +} // namespace testing + +#endif // GTEST_SRC_GTEST_INTERNAL_INL_H_ diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-port.cc b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-port.cc new file mode 100644 index 0000000000..3adc50ba77 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-port.cc @@ -0,0 +1,746 @@ +// Copyright 2008, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) + +#include "gtest/internal/gtest-port.h" + +#include +#include +#include +#include + +#if GTEST_OS_WINDOWS_MOBILE +# include // For TerminateProcess() +#elif GTEST_OS_WINDOWS +# include +# include +#else +# include +#endif // GTEST_OS_WINDOWS_MOBILE + +#if GTEST_OS_MAC +# include +# include +# include +#endif // GTEST_OS_MAC + +#include "gtest/gtest-spi.h" +#include "gtest/gtest-message.h" +#include "gtest/internal/gtest-internal.h" +#include "gtest/internal/gtest-string.h" + +// Indicates that this translation unit is part of Google Test's +// implementation. It must come before gtest-internal-inl.h is +// included, or there will be a compiler error. This trick is to +// prevent a user from accidentally including gtest-internal-inl.h in +// his code. +#define GTEST_IMPLEMENTATION_ 1 +#include "src/gtest-internal-inl.h" +#undef GTEST_IMPLEMENTATION_ + +namespace testing { +namespace internal { + +#if defined(_MSC_VER) || defined(__BORLANDC__) +// MSVC and C++Builder do not provide a definition of STDERR_FILENO. +const int kStdOutFileno = 1; +const int kStdErrFileno = 2; +#else +const int kStdOutFileno = STDOUT_FILENO; +const int kStdErrFileno = STDERR_FILENO; +#endif // _MSC_VER + +#if GTEST_OS_MAC + +// Returns the number of threads running in the process, or 0 to indicate that +// we cannot detect it. +size_t GetThreadCount() { + const task_t task = mach_task_self(); + mach_msg_type_number_t thread_count; + thread_act_array_t thread_list; + const kern_return_t status = task_threads(task, &thread_list, &thread_count); + if (status == KERN_SUCCESS) { + // task_threads allocates resources in thread_list and we need to free them + // to avoid leaks. + vm_deallocate(task, + reinterpret_cast(thread_list), + sizeof(thread_t) * thread_count); + return static_cast(thread_count); + } else { + return 0; + } +} + +#else + +size_t GetThreadCount() { + // There's no portable way to detect the number of threads, so we just + // return 0 to indicate that we cannot detect it. + return 0; +} + +#endif // GTEST_OS_MAC + +#if GTEST_USES_POSIX_RE + +// Implements RE. Currently only needed for death tests. + +RE::~RE() { + if (is_valid_) { + // regfree'ing an invalid regex might crash because the content + // of the regex is undefined. Since the regex's are essentially + // the same, one cannot be valid (or invalid) without the other + // being so too. + regfree(&partial_regex_); + regfree(&full_regex_); + } + free(const_cast(pattern_)); +} + +// Returns true iff regular expression re matches the entire str. +bool RE::FullMatch(const char* str, const RE& re) { + if (!re.is_valid_) return false; + + regmatch_t match; + return regexec(&re.full_regex_, str, 1, &match, 0) == 0; +} + +// Returns true iff regular expression re matches a substring of str +// (including str itself). +bool RE::PartialMatch(const char* str, const RE& re) { + if (!re.is_valid_) return false; + + regmatch_t match; + return regexec(&re.partial_regex_, str, 1, &match, 0) == 0; +} + +// Initializes an RE from its string representation. +void RE::Init(const char* regex) { + pattern_ = posix::StrDup(regex); + + // Reserves enough bytes to hold the regular expression used for a + // full match. + const size_t full_regex_len = strlen(regex) + 10; + char* const full_pattern = new char[full_regex_len]; + + snprintf(full_pattern, full_regex_len, "^(%s)$", regex); + is_valid_ = regcomp(&full_regex_, full_pattern, REG_EXTENDED) == 0; + // We want to call regcomp(&partial_regex_, ...) even if the + // previous expression returns false. Otherwise partial_regex_ may + // not be properly initialized can may cause trouble when it's + // freed. + // + // Some implementation of POSIX regex (e.g. on at least some + // versions of Cygwin) doesn't accept the empty string as a valid + // regex. We change it to an equivalent form "()" to be safe. + if (is_valid_) { + const char* const partial_regex = (*regex == '\0') ? "()" : regex; + is_valid_ = regcomp(&partial_regex_, partial_regex, REG_EXTENDED) == 0; + } + EXPECT_TRUE(is_valid_) + << "Regular expression \"" << regex + << "\" is not a valid POSIX Extended regular expression."; + + delete[] full_pattern; +} + +#elif GTEST_USES_SIMPLE_RE + +// Returns true iff ch appears anywhere in str (excluding the +// terminating '\0' character). +bool IsInSet(char ch, const char* str) { + return ch != '\0' && strchr(str, ch) != NULL; +} + +// Returns true iff ch belongs to the given classification. Unlike +// similar functions in , these aren't affected by the +// current locale. +bool IsAsciiDigit(char ch) { return '0' <= ch && ch <= '9'; } +bool IsAsciiPunct(char ch) { + return IsInSet(ch, "^-!\"#$%&'()*+,./:;<=>?@[\\]_`{|}~"); +} +bool IsRepeat(char ch) { return IsInSet(ch, "?*+"); } +bool IsAsciiWhiteSpace(char ch) { return IsInSet(ch, " \f\n\r\t\v"); } +bool IsAsciiWordChar(char ch) { + return ('a' <= ch && ch <= 'z') || ('A' <= ch && ch <= 'Z') || + ('0' <= ch && ch <= '9') || ch == '_'; +} + +// Returns true iff "\\c" is a supported escape sequence. +bool IsValidEscape(char c) { + return (IsAsciiPunct(c) || IsInSet(c, "dDfnrsStvwW")); +} + +// Returns true iff the given atom (specified by escaped and pattern) +// matches ch. The result is undefined if the atom is invalid. +bool AtomMatchesChar(bool escaped, char pattern_char, char ch) { + if (escaped) { // "\\p" where p is pattern_char. + switch (pattern_char) { + case 'd': return IsAsciiDigit(ch); + case 'D': return !IsAsciiDigit(ch); + case 'f': return ch == '\f'; + case 'n': return ch == '\n'; + case 'r': return ch == '\r'; + case 's': return IsAsciiWhiteSpace(ch); + case 'S': return !IsAsciiWhiteSpace(ch); + case 't': return ch == '\t'; + case 'v': return ch == '\v'; + case 'w': return IsAsciiWordChar(ch); + case 'W': return !IsAsciiWordChar(ch); + } + return IsAsciiPunct(pattern_char) && pattern_char == ch; + } + + return (pattern_char == '.' && ch != '\n') || pattern_char == ch; +} + +// Helper function used by ValidateRegex() to format error messages. +String FormatRegexSyntaxError(const char* regex, int index) { + return (Message() << "Syntax error at index " << index + << " in simple regular expression \"" << regex << "\": ").GetString(); +} + +// Generates non-fatal failures and returns false if regex is invalid; +// otherwise returns true. +bool ValidateRegex(const char* regex) { + if (regex == NULL) { + // TODO(wan@google.com): fix the source file location in the + // assertion failures to match where the regex is used in user + // code. + ADD_FAILURE() << "NULL is not a valid simple regular expression."; + return false; + } + + bool is_valid = true; + + // True iff ?, *, or + can follow the previous atom. + bool prev_repeatable = false; + for (int i = 0; regex[i]; i++) { + if (regex[i] == '\\') { // An escape sequence + i++; + if (regex[i] == '\0') { + ADD_FAILURE() << FormatRegexSyntaxError(regex, i - 1) + << "'\\' cannot appear at the end."; + return false; + } + + if (!IsValidEscape(regex[i])) { + ADD_FAILURE() << FormatRegexSyntaxError(regex, i - 1) + << "invalid escape sequence \"\\" << regex[i] << "\"."; + is_valid = false; + } + prev_repeatable = true; + } else { // Not an escape sequence. + const char ch = regex[i]; + + if (ch == '^' && i > 0) { + ADD_FAILURE() << FormatRegexSyntaxError(regex, i) + << "'^' can only appear at the beginning."; + is_valid = false; + } else if (ch == '$' && regex[i + 1] != '\0') { + ADD_FAILURE() << FormatRegexSyntaxError(regex, i) + << "'$' can only appear at the end."; + is_valid = false; + } else if (IsInSet(ch, "()[]{}|")) { + ADD_FAILURE() << FormatRegexSyntaxError(regex, i) + << "'" << ch << "' is unsupported."; + is_valid = false; + } else if (IsRepeat(ch) && !prev_repeatable) { + ADD_FAILURE() << FormatRegexSyntaxError(regex, i) + << "'" << ch << "' can only follow a repeatable token."; + is_valid = false; + } + + prev_repeatable = !IsInSet(ch, "^$?*+"); + } + } + + return is_valid; +} + +// Matches a repeated regex atom followed by a valid simple regular +// expression. The regex atom is defined as c if escaped is false, +// or \c otherwise. repeat is the repetition meta character (?, *, +// or +). The behavior is undefined if str contains too many +// characters to be indexable by size_t, in which case the test will +// probably time out anyway. We are fine with this limitation as +// std::string has it too. +bool MatchRepetitionAndRegexAtHead( + bool escaped, char c, char repeat, const char* regex, + const char* str) { + const size_t min_count = (repeat == '+') ? 1 : 0; + const size_t max_count = (repeat == '?') ? 1 : + static_cast(-1) - 1; + // We cannot call numeric_limits::max() as it conflicts with the + // max() macro on Windows. + + for (size_t i = 0; i <= max_count; ++i) { + // We know that the atom matches each of the first i characters in str. + if (i >= min_count && MatchRegexAtHead(regex, str + i)) { + // We have enough matches at the head, and the tail matches too. + // Since we only care about *whether* the pattern matches str + // (as opposed to *how* it matches), there is no need to find a + // greedy match. + return true; + } + if (str[i] == '\0' || !AtomMatchesChar(escaped, c, str[i])) + return false; + } + return false; +} + +// Returns true iff regex matches a prefix of str. regex must be a +// valid simple regular expression and not start with "^", or the +// result is undefined. +bool MatchRegexAtHead(const char* regex, const char* str) { + if (*regex == '\0') // An empty regex matches a prefix of anything. + return true; + + // "$" only matches the end of a string. Note that regex being + // valid guarantees that there's nothing after "$" in it. + if (*regex == '$') + return *str == '\0'; + + // Is the first thing in regex an escape sequence? + const bool escaped = *regex == '\\'; + if (escaped) + ++regex; + if (IsRepeat(regex[1])) { + // MatchRepetitionAndRegexAtHead() calls MatchRegexAtHead(), so + // here's an indirect recursion. It terminates as the regex gets + // shorter in each recursion. + return MatchRepetitionAndRegexAtHead( + escaped, regex[0], regex[1], regex + 2, str); + } else { + // regex isn't empty, isn't "$", and doesn't start with a + // repetition. We match the first atom of regex with the first + // character of str and recurse. + return (*str != '\0') && AtomMatchesChar(escaped, *regex, *str) && + MatchRegexAtHead(regex + 1, str + 1); + } +} + +// Returns true iff regex matches any substring of str. regex must be +// a valid simple regular expression, or the result is undefined. +// +// The algorithm is recursive, but the recursion depth doesn't exceed +// the regex length, so we won't need to worry about running out of +// stack space normally. In rare cases the time complexity can be +// exponential with respect to the regex length + the string length, +// but usually it's must faster (often close to linear). +bool MatchRegexAnywhere(const char* regex, const char* str) { + if (regex == NULL || str == NULL) + return false; + + if (*regex == '^') + return MatchRegexAtHead(regex + 1, str); + + // A successful match can be anywhere in str. + do { + if (MatchRegexAtHead(regex, str)) + return true; + } while (*str++ != '\0'); + return false; +} + +// Implements the RE class. + +RE::~RE() { + free(const_cast(pattern_)); + free(const_cast(full_pattern_)); +} + +// Returns true iff regular expression re matches the entire str. +bool RE::FullMatch(const char* str, const RE& re) { + return re.is_valid_ && MatchRegexAnywhere(re.full_pattern_, str); +} + +// Returns true iff regular expression re matches a substring of str +// (including str itself). +bool RE::PartialMatch(const char* str, const RE& re) { + return re.is_valid_ && MatchRegexAnywhere(re.pattern_, str); +} + +// Initializes an RE from its string representation. +void RE::Init(const char* regex) { + pattern_ = full_pattern_ = NULL; + if (regex != NULL) { + pattern_ = posix::StrDup(regex); + } + + is_valid_ = ValidateRegex(regex); + if (!is_valid_) { + // No need to calculate the full pattern when the regex is invalid. + return; + } + + const size_t len = strlen(regex); + // Reserves enough bytes to hold the regular expression used for a + // full match: we need space to prepend a '^', append a '$', and + // terminate the string with '\0'. + char* buffer = static_cast(malloc(len + 3)); + full_pattern_ = buffer; + + if (*regex != '^') + *buffer++ = '^'; // Makes sure full_pattern_ starts with '^'. + + // We don't use snprintf or strncpy, as they trigger a warning when + // compiled with VC++ 8.0. + memcpy(buffer, regex, len); + buffer += len; + + if (len == 0 || regex[len - 1] != '$') + *buffer++ = '$'; // Makes sure full_pattern_ ends with '$'. + + *buffer = '\0'; +} + +#endif // GTEST_USES_POSIX_RE + +const char kUnknownFile[] = "unknown file"; + +// Formats a source file path and a line number as they would appear +// in an error message from the compiler used to compile this code. +GTEST_API_ ::std::string FormatFileLocation(const char* file, int line) { + const char* const file_name = file == NULL ? kUnknownFile : file; + + if (line < 0) { + return String::Format("%s:", file_name).c_str(); + } +#ifdef _MSC_VER + return String::Format("%s(%d):", file_name, line).c_str(); +#else + return String::Format("%s:%d:", file_name, line).c_str(); +#endif // _MSC_VER +} + +// Formats a file location for compiler-independent XML output. +// Although this function is not platform dependent, we put it next to +// FormatFileLocation in order to contrast the two functions. +// Note that FormatCompilerIndependentFileLocation() does NOT append colon +// to the file location it produces, unlike FormatFileLocation(). +GTEST_API_ ::std::string FormatCompilerIndependentFileLocation( + const char* file, int line) { + const char* const file_name = file == NULL ? kUnknownFile : file; + + if (line < 0) + return file_name; + else + return String::Format("%s:%d", file_name, line).c_str(); +} + + +GTestLog::GTestLog(GTestLogSeverity severity, const char* file, int line) + : severity_(severity) { + const char* const marker = + severity == GTEST_INFO ? "[ INFO ]" : + severity == GTEST_WARNING ? "[WARNING]" : + severity == GTEST_ERROR ? "[ ERROR ]" : "[ FATAL ]"; + GetStream() << ::std::endl << marker << " " + << FormatFileLocation(file, line).c_str() << ": "; +} + +// Flushes the buffers and, if severity is GTEST_FATAL, aborts the program. +GTestLog::~GTestLog() { + GetStream() << ::std::endl; + if (severity_ == GTEST_FATAL) { + fflush(stderr); + posix::Abort(); + } +} +// Disable Microsoft deprecation warnings for POSIX functions called from +// this class (creat, dup, dup2, and close) +#ifdef _MSC_VER +# pragma warning(push) +# pragma warning(disable: 4996) +#endif // _MSC_VER + +#if GTEST_HAS_STREAM_REDIRECTION + +// Object that captures an output stream (stdout/stderr). +class CapturedStream { + public: + // The ctor redirects the stream to a temporary file. + CapturedStream(int fd) : fd_(fd), uncaptured_fd_(dup(fd)) { + +# if GTEST_OS_WINDOWS + char temp_dir_path[MAX_PATH + 1] = { '\0' }; // NOLINT + char temp_file_path[MAX_PATH + 1] = { '\0' }; // NOLINT + + ::GetTempPathA(sizeof(temp_dir_path), temp_dir_path); + const UINT success = ::GetTempFileNameA(temp_dir_path, + "gtest_redir", + 0, // Generate unique file name. + temp_file_path); + GTEST_CHECK_(success != 0) + << "Unable to create a temporary file in " << temp_dir_path; + const int captured_fd = creat(temp_file_path, _S_IREAD | _S_IWRITE); + GTEST_CHECK_(captured_fd != -1) << "Unable to open temporary file " + << temp_file_path; + filename_ = temp_file_path; +# else + // There's no guarantee that a test has write access to the + // current directory, so we create the temporary file in the /tmp + // directory instead. + char name_template[] = "/tmp/captured_stream.XXXXXX"; + const int captured_fd = mkstemp(name_template); + filename_ = name_template; +# endif // GTEST_OS_WINDOWS + fflush(NULL); + dup2(captured_fd, fd_); + close(captured_fd); + } + + ~CapturedStream() { + remove(filename_.c_str()); + } + + String GetCapturedString() { + if (uncaptured_fd_ != -1) { + // Restores the original stream. + fflush(NULL); + dup2(uncaptured_fd_, fd_); + close(uncaptured_fd_); + uncaptured_fd_ = -1; + } + + FILE* const file = posix::FOpen(filename_.c_str(), "r"); + const String content = ReadEntireFile(file); + posix::FClose(file); + return content; + } + + private: + // Reads the entire content of a file as a String. + static String ReadEntireFile(FILE* file); + + // Returns the size (in bytes) of a file. + static size_t GetFileSize(FILE* file); + + const int fd_; // A stream to capture. + int uncaptured_fd_; + // Name of the temporary file holding the stderr output. + ::std::string filename_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(CapturedStream); +}; + +// Returns the size (in bytes) of a file. +size_t CapturedStream::GetFileSize(FILE* file) { + fseek(file, 0, SEEK_END); + return static_cast(ftell(file)); +} + +// Reads the entire content of a file as a string. +String CapturedStream::ReadEntireFile(FILE* file) { + const size_t file_size = GetFileSize(file); + char* const buffer = new char[file_size]; + + size_t bytes_last_read = 0; // # of bytes read in the last fread() + size_t bytes_read = 0; // # of bytes read so far + + fseek(file, 0, SEEK_SET); + + // Keeps reading the file until we cannot read further or the + // pre-determined file size is reached. + do { + bytes_last_read = fread(buffer+bytes_read, 1, file_size-bytes_read, file); + bytes_read += bytes_last_read; + } while (bytes_last_read > 0 && bytes_read < file_size); + + const String content(buffer, bytes_read); + delete[] buffer; + + return content; +} + +# ifdef _MSC_VER +# pragma warning(pop) +# endif // _MSC_VER + +static CapturedStream* g_captured_stderr = NULL; +static CapturedStream* g_captured_stdout = NULL; + +// Starts capturing an output stream (stdout/stderr). +void CaptureStream(int fd, const char* stream_name, CapturedStream** stream) { + if (*stream != NULL) { + GTEST_LOG_(FATAL) << "Only one " << stream_name + << " capturer can exist at a time."; + } + *stream = new CapturedStream(fd); +} + +// Stops capturing the output stream and returns the captured string. +String GetCapturedStream(CapturedStream** captured_stream) { + const String content = (*captured_stream)->GetCapturedString(); + + delete *captured_stream; + *captured_stream = NULL; + + return content; +} + +// Starts capturing stdout. +void CaptureStdout() { + CaptureStream(kStdOutFileno, "stdout", &g_captured_stdout); +} + +// Starts capturing stderr. +void CaptureStderr() { + CaptureStream(kStdErrFileno, "stderr", &g_captured_stderr); +} + +// Stops capturing stdout and returns the captured string. +String GetCapturedStdout() { return GetCapturedStream(&g_captured_stdout); } + +// Stops capturing stderr and returns the captured string. +String GetCapturedStderr() { return GetCapturedStream(&g_captured_stderr); } + +#endif // GTEST_HAS_STREAM_REDIRECTION + +#if GTEST_HAS_DEATH_TEST + +// A copy of all command line arguments. Set by InitGoogleTest(). +::std::vector g_argvs; + +// Returns the command line as a vector of strings. +const ::std::vector& GetArgvs() { return g_argvs; } + +#endif // GTEST_HAS_DEATH_TEST + +#if GTEST_OS_WINDOWS_MOBILE +namespace posix { +void Abort() { + DebugBreak(); + TerminateProcess(GetCurrentProcess(), 1); +} +} // namespace posix +#endif // GTEST_OS_WINDOWS_MOBILE + +// Returns the name of the environment variable corresponding to the +// given flag. For example, FlagToEnvVar("foo") will return +// "GTEST_FOO" in the open-source version. +static String FlagToEnvVar(const char* flag) { + const String full_flag = + (Message() << GTEST_FLAG_PREFIX_ << flag).GetString(); + + Message env_var; + for (size_t i = 0; i != full_flag.length(); i++) { + env_var << ToUpper(full_flag.c_str()[i]); + } + + return env_var.GetString(); +} + +// Parses 'str' for a 32-bit signed integer. If successful, writes +// the result to *value and returns true; otherwise leaves *value +// unchanged and returns false. +bool ParseInt32(const Message& src_text, const char* str, Int32* value) { + // Parses the environment variable as a decimal integer. + char* end = NULL; + const long long_value = strtol(str, &end, 10); // NOLINT + + // Has strtol() consumed all characters in the string? + if (*end != '\0') { + // No - an invalid character was encountered. + Message msg; + msg << "WARNING: " << src_text + << " is expected to be a 32-bit integer, but actually" + << " has value \"" << str << "\".\n"; + printf("%s", msg.GetString().c_str()); + fflush(stdout); + return false; + } + + // Is the parsed value in the range of an Int32? + const Int32 result = static_cast(long_value); + if (long_value == LONG_MAX || long_value == LONG_MIN || + // The parsed value overflows as a long. (strtol() returns + // LONG_MAX or LONG_MIN when the input overflows.) + result != long_value + // The parsed value overflows as an Int32. + ) { + Message msg; + msg << "WARNING: " << src_text + << " is expected to be a 32-bit integer, but actually" + << " has value " << str << ", which overflows.\n"; + printf("%s", msg.GetString().c_str()); + fflush(stdout); + return false; + } + + *value = result; + return true; +} + +// Reads and returns the Boolean environment variable corresponding to +// the given flag; if it's not set, returns default_value. +// +// The value is considered true iff it's not "0". +bool BoolFromGTestEnv(const char* flag, bool default_value) { + const String env_var = FlagToEnvVar(flag); + const char* const string_value = posix::GetEnv(env_var.c_str()); + return string_value == NULL ? + default_value : strcmp(string_value, "0") != 0; +} + +// Reads and returns a 32-bit integer stored in the environment +// variable corresponding to the given flag; if it isn't set or +// doesn't represent a valid 32-bit integer, returns default_value. +Int32 Int32FromGTestEnv(const char* flag, Int32 default_value) { + const String env_var = FlagToEnvVar(flag); + const char* const string_value = posix::GetEnv(env_var.c_str()); + if (string_value == NULL) { + // The environment variable is not set. + return default_value; + } + + Int32 result = default_value; + if (!ParseInt32(Message() << "Environment variable " << env_var, + string_value, &result)) { + printf("The default value %s is used.\n", + (Message() << default_value).GetString().c_str()); + fflush(stdout); + return default_value; + } + + return result; +} + +// Reads and returns the string environment variable corresponding to +// the given flag; if it's not set, returns default_value. +const char* StringFromGTestEnv(const char* flag, const char* default_value) { + const String env_var = FlagToEnvVar(flag); + const char* const value = posix::GetEnv(env_var.c_str()); + return value == NULL ? default_value : value; +} + +} // namespace internal +} // namespace testing diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-printers.cc b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-printers.cc new file mode 100644 index 0000000000..03da4c35f8 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-printers.cc @@ -0,0 +1,356 @@ +// Copyright 2007, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) + +// Google Test - The Google C++ Testing Framework +// +// This file implements a universal value printer that can print a +// value of any type T: +// +// void ::testing::internal::UniversalPrinter::Print(value, ostream_ptr); +// +// It uses the << operator when possible, and prints the bytes in the +// object otherwise. A user can override its behavior for a class +// type Foo by defining either operator<<(::std::ostream&, const Foo&) +// or void PrintTo(const Foo&, ::std::ostream*) in the namespace that +// defines Foo. + +#include "gtest/gtest-printers.h" +#include +#include +#include // NOLINT +#include +#include "gtest/internal/gtest-port.h" + +namespace testing { + +namespace { + +using ::std::ostream; + +#if GTEST_OS_WINDOWS_MOBILE // Windows CE does not define _snprintf_s. +# define snprintf _snprintf +#elif _MSC_VER >= 1400 // VC 8.0 and later deprecate snprintf and _snprintf. +# define snprintf _snprintf_s +#elif _MSC_VER +# define snprintf _snprintf +#endif // GTEST_OS_WINDOWS_MOBILE + +// Prints a segment of bytes in the given object. +void PrintByteSegmentInObjectTo(const unsigned char* obj_bytes, size_t start, + size_t count, ostream* os) { + char text[5] = ""; + for (size_t i = 0; i != count; i++) { + const size_t j = start + i; + if (i != 0) { + // Organizes the bytes into groups of 2 for easy parsing by + // human. + if ((j % 2) == 0) + *os << ' '; + else + *os << '-'; + } + snprintf(text, sizeof(text), "%02X", obj_bytes[j]); + *os << text; + } +} + +// Prints the bytes in the given value to the given ostream. +void PrintBytesInObjectToImpl(const unsigned char* obj_bytes, size_t count, + ostream* os) { + // Tells the user how big the object is. + *os << count << "-byte object <"; + + const size_t kThreshold = 132; + const size_t kChunkSize = 64; + // If the object size is bigger than kThreshold, we'll have to omit + // some details by printing only the first and the last kChunkSize + // bytes. + // TODO(wan): let the user control the threshold using a flag. + if (count < kThreshold) { + PrintByteSegmentInObjectTo(obj_bytes, 0, count, os); + } else { + PrintByteSegmentInObjectTo(obj_bytes, 0, kChunkSize, os); + *os << " ... "; + // Rounds up to 2-byte boundary. + const size_t resume_pos = (count - kChunkSize + 1)/2*2; + PrintByteSegmentInObjectTo(obj_bytes, resume_pos, count - resume_pos, os); + } + *os << ">"; +} + +} // namespace + +namespace internal2 { + +// Delegates to PrintBytesInObjectToImpl() to print the bytes in the +// given object. The delegation simplifies the implementation, which +// uses the << operator and thus is easier done outside of the +// ::testing::internal namespace, which contains a << operator that +// sometimes conflicts with the one in STL. +void PrintBytesInObjectTo(const unsigned char* obj_bytes, size_t count, + ostream* os) { + PrintBytesInObjectToImpl(obj_bytes, count, os); +} + +} // namespace internal2 + +namespace internal { + +// Depending on the value of a char (or wchar_t), we print it in one +// of three formats: +// - as is if it's a printable ASCII (e.g. 'a', '2', ' '), +// - as a hexidecimal escape sequence (e.g. '\x7F'), or +// - as a special escape sequence (e.g. '\r', '\n'). +enum CharFormat { + kAsIs, + kHexEscape, + kSpecialEscape +}; + +// Returns true if c is a printable ASCII character. We test the +// value of c directly instead of calling isprint(), which is buggy on +// Windows Mobile. +inline bool IsPrintableAscii(wchar_t c) { + return 0x20 <= c && c <= 0x7E; +} + +// Prints a wide or narrow char c as a character literal without the +// quotes, escaping it when necessary; returns how c was formatted. +// The template argument UnsignedChar is the unsigned version of Char, +// which is the type of c. +template +static CharFormat PrintAsCharLiteralTo(Char c, ostream* os) { + switch (static_cast(c)) { + case L'\0': + *os << "\\0"; + break; + case L'\'': + *os << "\\'"; + break; + case L'\\': + *os << "\\\\"; + break; + case L'\a': + *os << "\\a"; + break; + case L'\b': + *os << "\\b"; + break; + case L'\f': + *os << "\\f"; + break; + case L'\n': + *os << "\\n"; + break; + case L'\r': + *os << "\\r"; + break; + case L'\t': + *os << "\\t"; + break; + case L'\v': + *os << "\\v"; + break; + default: + if (IsPrintableAscii(c)) { + *os << static_cast(c); + return kAsIs; + } else { + *os << String::Format("\\x%X", static_cast(c)); + return kHexEscape; + } + } + return kSpecialEscape; +} + +// Prints a char c as if it's part of a string literal, escaping it when +// necessary; returns how c was formatted. +static CharFormat PrintAsWideStringLiteralTo(wchar_t c, ostream* os) { + switch (c) { + case L'\'': + *os << "'"; + return kAsIs; + case L'"': + *os << "\\\""; + return kSpecialEscape; + default: + return PrintAsCharLiteralTo(c, os); + } +} + +// Prints a char c as if it's part of a string literal, escaping it when +// necessary; returns how c was formatted. +static CharFormat PrintAsNarrowStringLiteralTo(char c, ostream* os) { + return PrintAsWideStringLiteralTo(static_cast(c), os); +} + +// Prints a wide or narrow character c and its code. '\0' is printed +// as "'\\0'", other unprintable characters are also properly escaped +// using the standard C++ escape sequence. The template argument +// UnsignedChar is the unsigned version of Char, which is the type of c. +template +void PrintCharAndCodeTo(Char c, ostream* os) { + // First, print c as a literal in the most readable form we can find. + *os << ((sizeof(c) > 1) ? "L'" : "'"); + const CharFormat format = PrintAsCharLiteralTo(c, os); + *os << "'"; + + // To aid user debugging, we also print c's code in decimal, unless + // it's 0 (in which case c was printed as '\\0', making the code + // obvious). + if (c == 0) + return; + *os << " (" << String::Format("%d", c).c_str(); + + // For more convenience, we print c's code again in hexidecimal, + // unless c was already printed in the form '\x##' or the code is in + // [1, 9]. + if (format == kHexEscape || (1 <= c && c <= 9)) { + // Do nothing. + } else { + *os << String::Format(", 0x%X", + static_cast(c)).c_str(); + } + *os << ")"; +} + +void PrintTo(unsigned char c, ::std::ostream* os) { + PrintCharAndCodeTo(c, os); +} +void PrintTo(signed char c, ::std::ostream* os) { + PrintCharAndCodeTo(c, os); +} + +// Prints a wchar_t as a symbol if it is printable or as its internal +// code otherwise and also as its code. L'\0' is printed as "L'\\0'". +void PrintTo(wchar_t wc, ostream* os) { + PrintCharAndCodeTo(wc, os); +} + +// Prints the given array of characters to the ostream. +// The array starts at *begin, the length is len, it may include '\0' characters +// and may not be null-terminated. +static void PrintCharsAsStringTo(const char* begin, size_t len, ostream* os) { + *os << "\""; + bool is_previous_hex = false; + for (size_t index = 0; index < len; ++index) { + const char cur = begin[index]; + if (is_previous_hex && IsXDigit(cur)) { + // Previous character is of '\x..' form and this character can be + // interpreted as another hexadecimal digit in its number. Break string to + // disambiguate. + *os << "\" \""; + } + is_previous_hex = PrintAsNarrowStringLiteralTo(cur, os) == kHexEscape; + } + *os << "\""; +} + +// Prints a (const) char array of 'len' elements, starting at address 'begin'. +void UniversalPrintArray(const char* begin, size_t len, ostream* os) { + PrintCharsAsStringTo(begin, len, os); +} + +// Prints the given array of wide characters to the ostream. +// The array starts at *begin, the length is len, it may include L'\0' +// characters and may not be null-terminated. +static void PrintWideCharsAsStringTo(const wchar_t* begin, size_t len, + ostream* os) { + *os << "L\""; + bool is_previous_hex = false; + for (size_t index = 0; index < len; ++index) { + const wchar_t cur = begin[index]; + if (is_previous_hex && isascii(cur) && IsXDigit(static_cast(cur))) { + // Previous character is of '\x..' form and this character can be + // interpreted as another hexadecimal digit in its number. Break string to + // disambiguate. + *os << "\" L\""; + } + is_previous_hex = PrintAsWideStringLiteralTo(cur, os) == kHexEscape; + } + *os << "\""; +} + +// Prints the given C string to the ostream. +void PrintTo(const char* s, ostream* os) { + if (s == NULL) { + *os << "NULL"; + } else { + *os << ImplicitCast_(s) << " pointing to "; + PrintCharsAsStringTo(s, strlen(s), os); + } +} + +// MSVC compiler can be configured to define whar_t as a typedef +// of unsigned short. Defining an overload for const wchar_t* in that case +// would cause pointers to unsigned shorts be printed as wide strings, +// possibly accessing more memory than intended and causing invalid +// memory accesses. MSVC defines _NATIVE_WCHAR_T_DEFINED symbol when +// wchar_t is implemented as a native type. +#if !defined(_MSC_VER) || defined(_NATIVE_WCHAR_T_DEFINED) +// Prints the given wide C string to the ostream. +void PrintTo(const wchar_t* s, ostream* os) { + if (s == NULL) { + *os << "NULL"; + } else { + *os << ImplicitCast_(s) << " pointing to "; + PrintWideCharsAsStringTo(s, wcslen(s), os); + } +} +#endif // wchar_t is native + +// Prints a ::string object. +#if GTEST_HAS_GLOBAL_STRING +void PrintStringTo(const ::string& s, ostream* os) { + PrintCharsAsStringTo(s.data(), s.size(), os); +} +#endif // GTEST_HAS_GLOBAL_STRING + +void PrintStringTo(const ::std::string& s, ostream* os) { + PrintCharsAsStringTo(s.data(), s.size(), os); +} + +// Prints a ::wstring object. +#if GTEST_HAS_GLOBAL_WSTRING +void PrintWideStringTo(const ::wstring& s, ostream* os) { + PrintWideCharsAsStringTo(s.data(), s.size(), os); +} +#endif // GTEST_HAS_GLOBAL_WSTRING + +#if GTEST_HAS_STD_WSTRING +void PrintWideStringTo(const ::std::wstring& s, ostream* os) { + PrintWideCharsAsStringTo(s.data(), s.size(), os); +} +#endif // GTEST_HAS_STD_WSTRING + +} // namespace internal + +} // namespace testing diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-test-part.cc b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-test-part.cc new file mode 100644 index 0000000000..ceb7d10004 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-test-part.cc @@ -0,0 +1,110 @@ +// Copyright 2008, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: mheule@google.com (Markus Heule) +// +// The Google C++ Testing Framework (Google Test) + +#include "gtest/gtest-test-part.h" + +// Indicates that this translation unit is part of Google Test's +// implementation. It must come before gtest-internal-inl.h is +// included, or there will be a compiler error. This trick is to +// prevent a user from accidentally including gtest-internal-inl.h in +// his code. +#define GTEST_IMPLEMENTATION_ 1 +#include "src/gtest-internal-inl.h" +#undef GTEST_IMPLEMENTATION_ + +namespace testing { + +using internal::GetUnitTestImpl; + +// Gets the summary of the failure message by omitting the stack trace +// in it. +internal::String TestPartResult::ExtractSummary(const char* message) { + const char* const stack_trace = strstr(message, internal::kStackTraceMarker); + return stack_trace == NULL ? internal::String(message) : + internal::String(message, stack_trace - message); +} + +// Prints a TestPartResult object. +std::ostream& operator<<(std::ostream& os, const TestPartResult& result) { + return os + << result.file_name() << ":" << result.line_number() << ": " + << (result.type() == TestPartResult::kSuccess ? "Success" : + result.type() == TestPartResult::kFatalFailure ? "Fatal failure" : + "Non-fatal failure") << ":\n" + << result.message() << std::endl; +} + +// Appends a TestPartResult to the array. +void TestPartResultArray::Append(const TestPartResult& result) { + array_.push_back(result); +} + +// Returns the TestPartResult at the given index (0-based). +const TestPartResult& TestPartResultArray::GetTestPartResult(int index) const { + if (index < 0 || index >= size()) { + printf("\nInvalid index (%d) into TestPartResultArray.\n", index); + internal::posix::Abort(); + } + + return array_[index]; +} + +// Returns the number of TestPartResult objects in the array. +int TestPartResultArray::size() const { + return static_cast(array_.size()); +} + +namespace internal { + +HasNewFatalFailureHelper::HasNewFatalFailureHelper() + : has_new_fatal_failure_(false), + original_reporter_(GetUnitTestImpl()-> + GetTestPartResultReporterForCurrentThread()) { + GetUnitTestImpl()->SetTestPartResultReporterForCurrentThread(this); +} + +HasNewFatalFailureHelper::~HasNewFatalFailureHelper() { + GetUnitTestImpl()->SetTestPartResultReporterForCurrentThread( + original_reporter_); +} + +void HasNewFatalFailureHelper::ReportTestPartResult( + const TestPartResult& result) { + if (result.fatally_failed()) + has_new_fatal_failure_ = true; + original_reporter_->ReportTestPartResult(result); +} + +} // namespace internal + +} // namespace testing diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-typed-test.cc b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-typed-test.cc new file mode 100644 index 0000000000..6e185b919a --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest-typed-test.cc @@ -0,0 +1,110 @@ +// Copyright 2008 Google Inc. +// All Rights Reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) + +#include "gtest/gtest-typed-test.h" +#include "gtest/gtest.h" + +namespace testing { +namespace internal { + +#if GTEST_HAS_TYPED_TEST_P + +// Skips to the first non-space char in str. Returns an empty string if str +// contains only whitespace characters. +static const char* SkipSpaces(const char* str) { + while (IsSpace(*str)) + str++; + return str; +} + +// Verifies that registered_tests match the test names in +// defined_test_names_; returns registered_tests if successful, or +// aborts the program otherwise. +const char* TypedTestCasePState::VerifyRegisteredTestNames( + const char* file, int line, const char* registered_tests) { + typedef ::std::set::const_iterator DefinedTestIter; + registered_ = true; + + // Skip initial whitespace in registered_tests since some + // preprocessors prefix stringizied literals with whitespace. + registered_tests = SkipSpaces(registered_tests); + + Message errors; + ::std::set tests; + for (const char* names = registered_tests; names != NULL; + names = SkipComma(names)) { + const String name = GetPrefixUntilComma(names); + if (tests.count(name) != 0) { + errors << "Test " << name << " is listed more than once.\n"; + continue; + } + + bool found = false; + for (DefinedTestIter it = defined_test_names_.begin(); + it != defined_test_names_.end(); + ++it) { + if (name == *it) { + found = true; + break; + } + } + + if (found) { + tests.insert(name); + } else { + errors << "No test named " << name + << " can be found in this test case.\n"; + } + } + + for (DefinedTestIter it = defined_test_names_.begin(); + it != defined_test_names_.end(); + ++it) { + if (tests.count(*it) == 0) { + errors << "You forgot to list test " << *it << ".\n"; + } + } + + const String& errors_str = errors.GetString(); + if (errors_str != "") { + fprintf(stderr, "%s %s", FormatFileLocation(file, line).c_str(), + errors_str.c_str()); + fflush(stderr); + posix::Abort(); + } + + return registered_tests; +} + +#endif // GTEST_HAS_TYPED_TEST_P + +} // namespace internal +} // namespace testing diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest.cc b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest.cc new file mode 100644 index 0000000000..20b6e477e4 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest.cc @@ -0,0 +1,4898 @@ +// Copyright 2005, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// Author: wan@google.com (Zhanyong Wan) +// +// The Google C++ Testing Framework (Google Test) + +#include "gtest/gtest.h" +#include "gtest/gtest-spi.h" + +#include +#include +#include +#include +#include +#include +#include + +#include +#include // NOLINT +#include +#include + +#if GTEST_OS_LINUX + +// TODO(kenton@google.com): Use autoconf to detect availability of +// gettimeofday(). +# define GTEST_HAS_GETTIMEOFDAY_ 1 + +# include // NOLINT +# include // NOLINT +# include // NOLINT +// Declares vsnprintf(). This header is not available on Windows. +# include // NOLINT +# include // NOLINT +# include // NOLINT +# include // NOLINT +# include + +#elif GTEST_OS_SYMBIAN +# define GTEST_HAS_GETTIMEOFDAY_ 1 +# include // NOLINT + +#elif GTEST_OS_ZOS +# define GTEST_HAS_GETTIMEOFDAY_ 1 +# include // NOLINT + +// On z/OS we additionally need strings.h for strcasecmp. +# include // NOLINT + +#elif GTEST_OS_WINDOWS_MOBILE // We are on Windows CE. + +# include // NOLINT + +#elif GTEST_OS_WINDOWS // We are on Windows proper. + +# include // NOLINT +# include // NOLINT +# include // NOLINT +# include // NOLINT + +# if GTEST_OS_WINDOWS_MINGW +// MinGW has gettimeofday() but not _ftime64(). +// TODO(kenton@google.com): Use autoconf to detect availability of +// gettimeofday(). +// TODO(kenton@google.com): There are other ways to get the time on +// Windows, like GetTickCount() or GetSystemTimeAsFileTime(). MinGW +// supports these. consider using them instead. +# define GTEST_HAS_GETTIMEOFDAY_ 1 +# include // NOLINT +# endif // GTEST_OS_WINDOWS_MINGW + +// cpplint thinks that the header is already included, so we want to +// silence it. +# include // NOLINT + +#else + +// Assume other platforms have gettimeofday(). +// TODO(kenton@google.com): Use autoconf to detect availability of +// gettimeofday(). +# define GTEST_HAS_GETTIMEOFDAY_ 1 + +// cpplint thinks that the header is already included, so we want to +// silence it. +# include // NOLINT +# include // NOLINT + +#endif // GTEST_OS_LINUX + +#if GTEST_HAS_EXCEPTIONS +# include +#endif + +#if GTEST_CAN_STREAM_RESULTS_ +# include // NOLINT +# include // NOLINT +#endif + +// Indicates that this translation unit is part of Google Test's +// implementation. It must come before gtest-internal-inl.h is +// included, or there will be a compiler error. This trick is to +// prevent a user from accidentally including gtest-internal-inl.h in +// his code. +#define GTEST_IMPLEMENTATION_ 1 +#include "src/gtest-internal-inl.h" +#undef GTEST_IMPLEMENTATION_ + +#if GTEST_OS_WINDOWS +# define vsnprintf _vsnprintf +#endif // GTEST_OS_WINDOWS + +namespace testing { + +using internal::CountIf; +using internal::ForEach; +using internal::GetElementOr; +using internal::Shuffle; + +// Constants. + +// A test whose test case name or test name matches this filter is +// disabled and not run. +static const char kDisableTestFilter[] = "DISABLED_*:*/DISABLED_*"; + +// A test case whose name matches this filter is considered a death +// test case and will be run before test cases whose name doesn't +// match this filter. +static const char kDeathTestCaseFilter[] = "*DeathTest:*DeathTest/*"; + +// A test filter that matches everything. +static const char kUniversalFilter[] = "*"; + +// The default output file for XML output. +static const char kDefaultOutputFile[] = "test_detail.xml"; + +// The environment variable name for the test shard index. +static const char kTestShardIndex[] = "GTEST_SHARD_INDEX"; +// The environment variable name for the total number of test shards. +static const char kTestTotalShards[] = "GTEST_TOTAL_SHARDS"; +// The environment variable name for the test shard status file. +static const char kTestShardStatusFile[] = "GTEST_SHARD_STATUS_FILE"; + +namespace internal { + +// The text used in failure messages to indicate the start of the +// stack trace. +const char kStackTraceMarker[] = "\nStack trace:\n"; + +// g_help_flag is true iff the --help flag or an equivalent form is +// specified on the command line. +bool g_help_flag = false; + +} // namespace internal + +GTEST_DEFINE_bool_( + also_run_disabled_tests, + internal::BoolFromGTestEnv("also_run_disabled_tests", false), + "Run disabled tests too, in addition to the tests normally being run."); + +GTEST_DEFINE_bool_( + break_on_failure, + internal::BoolFromGTestEnv("break_on_failure", false), + "True iff a failed assertion should be a debugger break-point."); + +GTEST_DEFINE_bool_( + catch_exceptions, + internal::BoolFromGTestEnv("catch_exceptions", true), + "True iff " GTEST_NAME_ + " should catch exceptions and treat them as test failures."); + +GTEST_DEFINE_string_( + color, + internal::StringFromGTestEnv("color", "auto"), + "Whether to use colors in the output. Valid values: yes, no, " + "and auto. 'auto' means to use colors if the output is " + "being sent to a terminal and the TERM environment variable " + "is set to xterm, xterm-color, xterm-256color, linux or cygwin."); + +GTEST_DEFINE_string_( + filter, + internal::StringFromGTestEnv("filter", kUniversalFilter), + "A colon-separated list of glob (not regex) patterns " + "for filtering the tests to run, optionally followed by a " + "'-' and a : separated list of negative patterns (tests to " + "exclude). A test is run if it matches one of the positive " + "patterns and does not match any of the negative patterns."); + +GTEST_DEFINE_bool_(list_tests, false, + "List all tests without running them."); + +GTEST_DEFINE_string_( + output, + internal::StringFromGTestEnv("output", ""), + "A format (currently must be \"xml\"), optionally followed " + "by a colon and an output file name or directory. A directory " + "is indicated by a trailing pathname separator. " + "Examples: \"xml:filename.xml\", \"xml::directoryname/\". " + "If a directory is specified, output files will be created " + "within that directory, with file-names based on the test " + "executable's name and, if necessary, made unique by adding " + "digits."); + +GTEST_DEFINE_bool_( + print_time, + internal::BoolFromGTestEnv("print_time", true), + "True iff " GTEST_NAME_ + " should display elapsed time in text output."); + +GTEST_DEFINE_int32_( + random_seed, + internal::Int32FromGTestEnv("random_seed", 0), + "Random number seed to use when shuffling test orders. Must be in range " + "[1, 99999], or 0 to use a seed based on the current time."); + +GTEST_DEFINE_int32_( + repeat, + internal::Int32FromGTestEnv("repeat", 1), + "How many times to repeat each test. Specify a negative number " + "for repeating forever. Useful for shaking out flaky tests."); + +GTEST_DEFINE_bool_( + show_internal_stack_frames, false, + "True iff " GTEST_NAME_ " should include internal stack frames when " + "printing test failure stack traces."); + +GTEST_DEFINE_bool_( + shuffle, + internal::BoolFromGTestEnv("shuffle", false), + "True iff " GTEST_NAME_ + " should randomize tests' order on every run."); + +GTEST_DEFINE_int32_( + stack_trace_depth, + internal::Int32FromGTestEnv("stack_trace_depth", kMaxStackTraceDepth), + "The maximum number of stack frames to print when an " + "assertion fails. The valid range is 0 through 100, inclusive."); + +GTEST_DEFINE_string_( + stream_result_to, + internal::StringFromGTestEnv("stream_result_to", ""), + "This flag specifies the host name and the port number on which to stream " + "test results. Example: \"localhost:555\". The flag is effective only on " + "Linux."); + +GTEST_DEFINE_bool_( + throw_on_failure, + internal::BoolFromGTestEnv("throw_on_failure", false), + "When this flag is specified, a failed assertion will throw an exception " + "if exceptions are enabled or exit the program with a non-zero code " + "otherwise."); + +namespace internal { + +// Generates a random number from [0, range), using a Linear +// Congruential Generator (LCG). Crashes if 'range' is 0 or greater +// than kMaxRange. +UInt32 Random::Generate(UInt32 range) { + // These constants are the same as are used in glibc's rand(3). + state_ = (1103515245U*state_ + 12345U) % kMaxRange; + + GTEST_CHECK_(range > 0) + << "Cannot generate a number in the range [0, 0)."; + GTEST_CHECK_(range <= kMaxRange) + << "Generation of a number in [0, " << range << ") was requested, " + << "but this can only generate numbers in [0, " << kMaxRange << ")."; + + // Converting via modulus introduces a bit of downward bias, but + // it's simple, and a linear congruential generator isn't too good + // to begin with. + return state_ % range; +} + +// GTestIsInitialized() returns true iff the user has initialized +// Google Test. Useful for catching the user mistake of not initializing +// Google Test before calling RUN_ALL_TESTS(). +// +// A user must call testing::InitGoogleTest() to initialize Google +// Test. g_init_gtest_count is set to the number of times +// InitGoogleTest() has been called. We don't protect this variable +// under a mutex as it is only accessed in the main thread. +int g_init_gtest_count = 0; +static bool GTestIsInitialized() { return g_init_gtest_count != 0; } + +// Iterates over a vector of TestCases, keeping a running sum of the +// results of calling a given int-returning method on each. +// Returns the sum. +static int SumOverTestCaseList(const std::vector& case_list, + int (TestCase::*method)() const) { + int sum = 0; + for (size_t i = 0; i < case_list.size(); i++) { + sum += (case_list[i]->*method)(); + } + return sum; +} + +// Returns true iff the test case passed. +static bool TestCasePassed(const TestCase* test_case) { + return test_case->should_run() && test_case->Passed(); +} + +// Returns true iff the test case failed. +static bool TestCaseFailed(const TestCase* test_case) { + return test_case->should_run() && test_case->Failed(); +} + +// Returns true iff test_case contains at least one test that should +// run. +static bool ShouldRunTestCase(const TestCase* test_case) { + return test_case->should_run(); +} + +// AssertHelper constructor. +AssertHelper::AssertHelper(TestPartResult::Type type, + const char* file, + int line, + const char* message) + : data_(new AssertHelperData(type, file, line, message)) { +} + +AssertHelper::~AssertHelper() { + delete data_; +} + +// Message assignment, for assertion streaming support. +void AssertHelper::operator=(const Message& message) const { + UnitTest::GetInstance()-> + AddTestPartResult(data_->type, data_->file, data_->line, + AppendUserMessage(data_->message, message), + UnitTest::GetInstance()->impl() + ->CurrentOsStackTraceExceptTop(1) + // Skips the stack frame for this function itself. + ); // NOLINT +} + +// Mutex for linked pointers. +GTEST_DEFINE_STATIC_MUTEX_(g_linked_ptr_mutex); + +// Application pathname gotten in InitGoogleTest. +String g_executable_path; + +// Returns the current application's name, removing directory path if that +// is present. +FilePath GetCurrentExecutableName() { + FilePath result; + +#if GTEST_OS_WINDOWS + result.Set(FilePath(g_executable_path).RemoveExtension("exe")); +#else + result.Set(FilePath(g_executable_path)); +#endif // GTEST_OS_WINDOWS + + return result.RemoveDirectoryName(); +} + +// Functions for processing the gtest_output flag. + +// Returns the output format, or "" for normal printed output. +String UnitTestOptions::GetOutputFormat() { + const char* const gtest_output_flag = GTEST_FLAG(output).c_str(); + if (gtest_output_flag == NULL) return String(""); + + const char* const colon = strchr(gtest_output_flag, ':'); + return (colon == NULL) ? + String(gtest_output_flag) : + String(gtest_output_flag, colon - gtest_output_flag); +} + +// Returns the name of the requested output file, or the default if none +// was explicitly specified. +String UnitTestOptions::GetAbsolutePathToOutputFile() { + const char* const gtest_output_flag = GTEST_FLAG(output).c_str(); + if (gtest_output_flag == NULL) + return String(""); + + const char* const colon = strchr(gtest_output_flag, ':'); + if (colon == NULL) + return String(internal::FilePath::ConcatPaths( + internal::FilePath( + UnitTest::GetInstance()->original_working_dir()), + internal::FilePath(kDefaultOutputFile)).ToString() ); + + internal::FilePath output_name(colon + 1); + if (!output_name.IsAbsolutePath()) + // TODO(wan@google.com): on Windows \some\path is not an absolute + // path (as its meaning depends on the current drive), yet the + // following logic for turning it into an absolute path is wrong. + // Fix it. + output_name = internal::FilePath::ConcatPaths( + internal::FilePath(UnitTest::GetInstance()->original_working_dir()), + internal::FilePath(colon + 1)); + + if (!output_name.IsDirectory()) + return output_name.ToString(); + + internal::FilePath result(internal::FilePath::GenerateUniqueFileName( + output_name, internal::GetCurrentExecutableName(), + GetOutputFormat().c_str())); + return result.ToString(); +} + +// Returns true iff the wildcard pattern matches the string. The +// first ':' or '\0' character in pattern marks the end of it. +// +// This recursive algorithm isn't very efficient, but is clear and +// works well enough for matching test names, which are short. +bool UnitTestOptions::PatternMatchesString(const char *pattern, + const char *str) { + switch (*pattern) { + case '\0': + case ':': // Either ':' or '\0' marks the end of the pattern. + return *str == '\0'; + case '?': // Matches any single character. + return *str != '\0' && PatternMatchesString(pattern + 1, str + 1); + case '*': // Matches any string (possibly empty) of characters. + return (*str != '\0' && PatternMatchesString(pattern, str + 1)) || + PatternMatchesString(pattern + 1, str); + default: // Non-special character. Matches itself. + return *pattern == *str && + PatternMatchesString(pattern + 1, str + 1); + } +} + +bool UnitTestOptions::MatchesFilter(const String& name, const char* filter) { + const char *cur_pattern = filter; + for (;;) { + if (PatternMatchesString(cur_pattern, name.c_str())) { + return true; + } + + // Finds the next pattern in the filter. + cur_pattern = strchr(cur_pattern, ':'); + + // Returns if no more pattern can be found. + if (cur_pattern == NULL) { + return false; + } + + // Skips the pattern separater (the ':' character). + cur_pattern++; + } +} + +// TODO(keithray): move String function implementations to gtest-string.cc. + +// Returns true iff the user-specified filter matches the test case +// name and the test name. +bool UnitTestOptions::FilterMatchesTest(const String &test_case_name, + const String &test_name) { + const String& full_name = String::Format("%s.%s", + test_case_name.c_str(), + test_name.c_str()); + + // Split --gtest_filter at '-', if there is one, to separate into + // positive filter and negative filter portions + const char* const p = GTEST_FLAG(filter).c_str(); + const char* const dash = strchr(p, '-'); + String positive; + String negative; + if (dash == NULL) { + positive = GTEST_FLAG(filter).c_str(); // Whole string is a positive filter + negative = String(""); + } else { + positive = String(p, dash - p); // Everything up to the dash + negative = String(dash+1); // Everything after the dash + if (positive.empty()) { + // Treat '-test1' as the same as '*-test1' + positive = kUniversalFilter; + } + } + + // A filter is a colon-separated list of patterns. It matches a + // test if any pattern in it matches the test. + return (MatchesFilter(full_name, positive.c_str()) && + !MatchesFilter(full_name, negative.c_str())); +} + +#if GTEST_HAS_SEH +// Returns EXCEPTION_EXECUTE_HANDLER if Google Test should handle the +// given SEH exception, or EXCEPTION_CONTINUE_SEARCH otherwise. +// This function is useful as an __except condition. +int UnitTestOptions::GTestShouldProcessSEH(DWORD exception_code) { + // Google Test should handle a SEH exception if: + // 1. the user wants it to, AND + // 2. this is not a breakpoint exception, AND + // 3. this is not a C++ exception (VC++ implements them via SEH, + // apparently). + // + // SEH exception code for C++ exceptions. + // (see http://support.microsoft.com/kb/185294 for more information). + const DWORD kCxxExceptionCode = 0xe06d7363; + + bool should_handle = true; + + if (!GTEST_FLAG(catch_exceptions)) + should_handle = false; + else if (exception_code == EXCEPTION_BREAKPOINT) + should_handle = false; + else if (exception_code == kCxxExceptionCode) + should_handle = false; + + return should_handle ? EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH; +} +#endif // GTEST_HAS_SEH + +} // namespace internal + +// The c'tor sets this object as the test part result reporter used by +// Google Test. The 'result' parameter specifies where to report the +// results. Intercepts only failures from the current thread. +ScopedFakeTestPartResultReporter::ScopedFakeTestPartResultReporter( + TestPartResultArray* result) + : intercept_mode_(INTERCEPT_ONLY_CURRENT_THREAD), + result_(result) { + Init(); +} + +// The c'tor sets this object as the test part result reporter used by +// Google Test. The 'result' parameter specifies where to report the +// results. +ScopedFakeTestPartResultReporter::ScopedFakeTestPartResultReporter( + InterceptMode intercept_mode, TestPartResultArray* result) + : intercept_mode_(intercept_mode), + result_(result) { + Init(); +} + +void ScopedFakeTestPartResultReporter::Init() { + internal::UnitTestImpl* const impl = internal::GetUnitTestImpl(); + if (intercept_mode_ == INTERCEPT_ALL_THREADS) { + old_reporter_ = impl->GetGlobalTestPartResultReporter(); + impl->SetGlobalTestPartResultReporter(this); + } else { + old_reporter_ = impl->GetTestPartResultReporterForCurrentThread(); + impl->SetTestPartResultReporterForCurrentThread(this); + } +} + +// The d'tor restores the test part result reporter used by Google Test +// before. +ScopedFakeTestPartResultReporter::~ScopedFakeTestPartResultReporter() { + internal::UnitTestImpl* const impl = internal::GetUnitTestImpl(); + if (intercept_mode_ == INTERCEPT_ALL_THREADS) { + impl->SetGlobalTestPartResultReporter(old_reporter_); + } else { + impl->SetTestPartResultReporterForCurrentThread(old_reporter_); + } +} + +// Increments the test part result count and remembers the result. +// This method is from the TestPartResultReporterInterface interface. +void ScopedFakeTestPartResultReporter::ReportTestPartResult( + const TestPartResult& result) { + result_->Append(result); +} + +namespace internal { + +// Returns the type ID of ::testing::Test. We should always call this +// instead of GetTypeId< ::testing::Test>() to get the type ID of +// testing::Test. This is to work around a suspected linker bug when +// using Google Test as a framework on Mac OS X. The bug causes +// GetTypeId< ::testing::Test>() to return different values depending +// on whether the call is from the Google Test framework itself or +// from user test code. GetTestTypeId() is guaranteed to always +// return the same value, as it always calls GetTypeId<>() from the +// gtest.cc, which is within the Google Test framework. +TypeId GetTestTypeId() { + return GetTypeId(); +} + +// The value of GetTestTypeId() as seen from within the Google Test +// library. This is solely for testing GetTestTypeId(). +extern const TypeId kTestTypeIdInGoogleTest = GetTestTypeId(); + +// This predicate-formatter checks that 'results' contains a test part +// failure of the given type and that the failure message contains the +// given substring. +AssertionResult HasOneFailure(const char* /* results_expr */, + const char* /* type_expr */, + const char* /* substr_expr */, + const TestPartResultArray& results, + TestPartResult::Type type, + const string& substr) { + const String expected(type == TestPartResult::kFatalFailure ? + "1 fatal failure" : + "1 non-fatal failure"); + Message msg; + if (results.size() != 1) { + msg << "Expected: " << expected << "\n" + << " Actual: " << results.size() << " failures"; + for (int i = 0; i < results.size(); i++) { + msg << "\n" << results.GetTestPartResult(i); + } + return AssertionFailure() << msg; + } + + const TestPartResult& r = results.GetTestPartResult(0); + if (r.type() != type) { + return AssertionFailure() << "Expected: " << expected << "\n" + << " Actual:\n" + << r; + } + + if (strstr(r.message(), substr.c_str()) == NULL) { + return AssertionFailure() << "Expected: " << expected << " containing \"" + << substr << "\"\n" + << " Actual:\n" + << r; + } + + return AssertionSuccess(); +} + +// The constructor of SingleFailureChecker remembers where to look up +// test part results, what type of failure we expect, and what +// substring the failure message should contain. +SingleFailureChecker:: SingleFailureChecker( + const TestPartResultArray* results, + TestPartResult::Type type, + const string& substr) + : results_(results), + type_(type), + substr_(substr) {} + +// The destructor of SingleFailureChecker verifies that the given +// TestPartResultArray contains exactly one failure that has the given +// type and contains the given substring. If that's not the case, a +// non-fatal failure will be generated. +SingleFailureChecker::~SingleFailureChecker() { + EXPECT_PRED_FORMAT3(HasOneFailure, *results_, type_, substr_); +} + +DefaultGlobalTestPartResultReporter::DefaultGlobalTestPartResultReporter( + UnitTestImpl* unit_test) : unit_test_(unit_test) {} + +void DefaultGlobalTestPartResultReporter::ReportTestPartResult( + const TestPartResult& result) { + unit_test_->current_test_result()->AddTestPartResult(result); + unit_test_->listeners()->repeater()->OnTestPartResult(result); +} + +DefaultPerThreadTestPartResultReporter::DefaultPerThreadTestPartResultReporter( + UnitTestImpl* unit_test) : unit_test_(unit_test) {} + +void DefaultPerThreadTestPartResultReporter::ReportTestPartResult( + const TestPartResult& result) { + unit_test_->GetGlobalTestPartResultReporter()->ReportTestPartResult(result); +} + +// Returns the global test part result reporter. +TestPartResultReporterInterface* +UnitTestImpl::GetGlobalTestPartResultReporter() { + internal::MutexLock lock(&global_test_part_result_reporter_mutex_); + return global_test_part_result_repoter_; +} + +// Sets the global test part result reporter. +void UnitTestImpl::SetGlobalTestPartResultReporter( + TestPartResultReporterInterface* reporter) { + internal::MutexLock lock(&global_test_part_result_reporter_mutex_); + global_test_part_result_repoter_ = reporter; +} + +// Returns the test part result reporter for the current thread. +TestPartResultReporterInterface* +UnitTestImpl::GetTestPartResultReporterForCurrentThread() { + return per_thread_test_part_result_reporter_.get(); +} + +// Sets the test part result reporter for the current thread. +void UnitTestImpl::SetTestPartResultReporterForCurrentThread( + TestPartResultReporterInterface* reporter) { + per_thread_test_part_result_reporter_.set(reporter); +} + +// Gets the number of successful test cases. +int UnitTestImpl::successful_test_case_count() const { + return CountIf(test_cases_, TestCasePassed); +} + +// Gets the number of failed test cases. +int UnitTestImpl::failed_test_case_count() const { + return CountIf(test_cases_, TestCaseFailed); +} + +// Gets the number of all test cases. +int UnitTestImpl::total_test_case_count() const { + return static_cast(test_cases_.size()); +} + +// Gets the number of all test cases that contain at least one test +// that should run. +int UnitTestImpl::test_case_to_run_count() const { + return CountIf(test_cases_, ShouldRunTestCase); +} + +// Gets the number of successful tests. +int UnitTestImpl::successful_test_count() const { + return SumOverTestCaseList(test_cases_, &TestCase::successful_test_count); +} + +// Gets the number of failed tests. +int UnitTestImpl::failed_test_count() const { + return SumOverTestCaseList(test_cases_, &TestCase::failed_test_count); +} + +// Gets the number of disabled tests. +int UnitTestImpl::disabled_test_count() const { + return SumOverTestCaseList(test_cases_, &TestCase::disabled_test_count); +} + +// Gets the number of all tests. +int UnitTestImpl::total_test_count() const { + return SumOverTestCaseList(test_cases_, &TestCase::total_test_count); +} + +// Gets the number of tests that should run. +int UnitTestImpl::test_to_run_count() const { + return SumOverTestCaseList(test_cases_, &TestCase::test_to_run_count); +} + +// Returns the current OS stack trace as a String. +// +// The maximum number of stack frames to be included is specified by +// the gtest_stack_trace_depth flag. The skip_count parameter +// specifies the number of top frames to be skipped, which doesn't +// count against the number of frames to be included. +// +// For example, if Foo() calls Bar(), which in turn calls +// CurrentOsStackTraceExceptTop(1), Foo() will be included in the +// trace but Bar() and CurrentOsStackTraceExceptTop() won't. +String UnitTestImpl::CurrentOsStackTraceExceptTop(int skip_count) { + (void)skip_count; + return String(""); +} + +// Returns the current time in milliseconds. +TimeInMillis GetTimeInMillis() { +#if GTEST_OS_WINDOWS_MOBILE || defined(__BORLANDC__) + // Difference between 1970-01-01 and 1601-01-01 in milliseconds. + // http://analogous.blogspot.com/2005/04/epoch.html + const TimeInMillis kJavaEpochToWinFileTimeDelta = + static_cast(116444736UL) * 100000UL; + const DWORD kTenthMicrosInMilliSecond = 10000; + + SYSTEMTIME now_systime; + FILETIME now_filetime; + ULARGE_INTEGER now_int64; + // TODO(kenton@google.com): Shouldn't this just use + // GetSystemTimeAsFileTime()? + GetSystemTime(&now_systime); + if (SystemTimeToFileTime(&now_systime, &now_filetime)) { + now_int64.LowPart = now_filetime.dwLowDateTime; + now_int64.HighPart = now_filetime.dwHighDateTime; + now_int64.QuadPart = (now_int64.QuadPart / kTenthMicrosInMilliSecond) - + kJavaEpochToWinFileTimeDelta; + return now_int64.QuadPart; + } + return 0; +#elif GTEST_OS_WINDOWS && !GTEST_HAS_GETTIMEOFDAY_ + __timeb64 now; + +# ifdef _MSC_VER + + // MSVC 8 deprecates _ftime64(), so we want to suppress warning 4996 + // (deprecated function) there. + // TODO(kenton@google.com): Use GetTickCount()? Or use + // SystemTimeToFileTime() +# pragma warning(push) // Saves the current warning state. +# pragma warning(disable:4996) // Temporarily disables warning 4996. + _ftime64(&now); +# pragma warning(pop) // Restores the warning state. +# else + + _ftime64(&now); + +# endif // _MSC_VER + + return static_cast(now.time) * 1000 + now.millitm; +#elif GTEST_HAS_GETTIMEOFDAY_ + struct timeval now; + gettimeofday(&now, NULL); + return static_cast(now.tv_sec) * 1000 + now.tv_usec / 1000; +#else +# error "Don't know how to get the current time on your system." +#endif +} + +// Utilities + +// class String + +// Returns the input enclosed in double quotes if it's not NULL; +// otherwise returns "(null)". For example, "\"Hello\"" is returned +// for input "Hello". +// +// This is useful for printing a C string in the syntax of a literal. +// +// Known issue: escape sequences are not handled yet. +String String::ShowCStringQuoted(const char* c_str) { + return c_str ? String::Format("\"%s\"", c_str) : String("(null)"); +} + +// Copies at most length characters from str into a newly-allocated +// piece of memory of size length+1. The memory is allocated with new[]. +// A terminating null byte is written to the memory, and a pointer to it +// is returned. If str is NULL, NULL is returned. +static char* CloneString(const char* str, size_t length) { + if (str == NULL) { + return NULL; + } else { + char* const clone = new char[length + 1]; + posix::StrNCpy(clone, str, length); + clone[length] = '\0'; + return clone; + } +} + +// Clones a 0-terminated C string, allocating memory using new. The +// caller is responsible for deleting[] the return value. Returns the +// cloned string, or NULL if the input is NULL. +const char * String::CloneCString(const char* c_str) { + return (c_str == NULL) ? + NULL : CloneString(c_str, strlen(c_str)); +} + +#if GTEST_OS_WINDOWS_MOBILE +// Creates a UTF-16 wide string from the given ANSI string, allocating +// memory using new. The caller is responsible for deleting the return +// value using delete[]. Returns the wide string, or NULL if the +// input is NULL. +LPCWSTR String::AnsiToUtf16(const char* ansi) { + if (!ansi) return NULL; + const int length = strlen(ansi); + const int unicode_length = + MultiByteToWideChar(CP_ACP, 0, ansi, length, + NULL, 0); + WCHAR* unicode = new WCHAR[unicode_length + 1]; + MultiByteToWideChar(CP_ACP, 0, ansi, length, + unicode, unicode_length); + unicode[unicode_length] = 0; + return unicode; +} + +// Creates an ANSI string from the given wide string, allocating +// memory using new. The caller is responsible for deleting the return +// value using delete[]. Returns the ANSI string, or NULL if the +// input is NULL. +const char* String::Utf16ToAnsi(LPCWSTR utf16_str) { + if (!utf16_str) return NULL; + const int ansi_length = + WideCharToMultiByte(CP_ACP, 0, utf16_str, -1, + NULL, 0, NULL, NULL); + char* ansi = new char[ansi_length + 1]; + WideCharToMultiByte(CP_ACP, 0, utf16_str, -1, + ansi, ansi_length, NULL, NULL); + ansi[ansi_length] = 0; + return ansi; +} + +#endif // GTEST_OS_WINDOWS_MOBILE + +// Compares two C strings. Returns true iff they have the same content. +// +// Unlike strcmp(), this function can handle NULL argument(s). A NULL +// C string is considered different to any non-NULL C string, +// including the empty string. +bool String::CStringEquals(const char * lhs, const char * rhs) { + if ( lhs == NULL ) return rhs == NULL; + + if ( rhs == NULL ) return false; + + return strcmp(lhs, rhs) == 0; +} + +#if GTEST_HAS_STD_WSTRING || GTEST_HAS_GLOBAL_WSTRING + +// Converts an array of wide chars to a narrow string using the UTF-8 +// encoding, and streams the result to the given Message object. +static void StreamWideCharsToMessage(const wchar_t* wstr, size_t length, + Message* msg) { + // TODO(wan): consider allowing a testing::String object to + // contain '\0'. This will make it behave more like std::string, + // and will allow ToUtf8String() to return the correct encoding + // for '\0' s.t. we can get rid of the conditional here (and in + // several other places). + for (size_t i = 0; i != length; ) { // NOLINT + if (wstr[i] != L'\0') { + *msg << WideStringToUtf8(wstr + i, static_cast(length - i)); + while (i != length && wstr[i] != L'\0') + i++; + } else { + *msg << '\0'; + i++; + } + } +} + +#endif // GTEST_HAS_STD_WSTRING || GTEST_HAS_GLOBAL_WSTRING + +} // namespace internal + +#if GTEST_HAS_STD_WSTRING +// Converts the given wide string to a narrow string using the UTF-8 +// encoding, and streams the result to this Message object. +Message& Message::operator <<(const ::std::wstring& wstr) { + internal::StreamWideCharsToMessage(wstr.c_str(), wstr.length(), this); + return *this; +} +#endif // GTEST_HAS_STD_WSTRING + +#if GTEST_HAS_GLOBAL_WSTRING +// Converts the given wide string to a narrow string using the UTF-8 +// encoding, and streams the result to this Message object. +Message& Message::operator <<(const ::wstring& wstr) { + internal::StreamWideCharsToMessage(wstr.c_str(), wstr.length(), this); + return *this; +} +#endif // GTEST_HAS_GLOBAL_WSTRING + +// AssertionResult constructors. +// Used in EXPECT_TRUE/FALSE(assertion_result). +AssertionResult::AssertionResult(const AssertionResult& other) + : success_(other.success_), + message_(other.message_.get() != NULL ? + new ::std::string(*other.message_) : + static_cast< ::std::string*>(NULL)) { +} + +// Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE. +AssertionResult AssertionResult::operator!() const { + AssertionResult negation(!success_); + if (message_.get() != NULL) + negation << *message_; + return negation; +} + +// Makes a successful assertion result. +AssertionResult AssertionSuccess() { + return AssertionResult(true); +} + +// Makes a failed assertion result. +AssertionResult AssertionFailure() { + return AssertionResult(false); +} + +// Makes a failed assertion result with the given failure message. +// Deprecated; use AssertionFailure() << message. +AssertionResult AssertionFailure(const Message& message) { + return AssertionFailure() << message; +} + +namespace internal { + +// Constructs and returns the message for an equality assertion +// (e.g. ASSERT_EQ, EXPECT_STREQ, etc) failure. +// +// The first four parameters are the expressions used in the assertion +// and their values, as strings. For example, for ASSERT_EQ(foo, bar) +// where foo is 5 and bar is 6, we have: +// +// expected_expression: "foo" +// actual_expression: "bar" +// expected_value: "5" +// actual_value: "6" +// +// The ignoring_case parameter is true iff the assertion is a +// *_STRCASEEQ*. When it's true, the string " (ignoring case)" will +// be inserted into the message. +AssertionResult EqFailure(const char* expected_expression, + const char* actual_expression, + const String& expected_value, + const String& actual_value, + bool ignoring_case) { + Message msg; + msg << "Value of: " << actual_expression; + if (actual_value != actual_expression) { + msg << "\n Actual: " << actual_value; + } + + msg << "\nExpected: " << expected_expression; + if (ignoring_case) { + msg << " (ignoring case)"; + } + if (expected_value != expected_expression) { + msg << "\nWhich is: " << expected_value; + } + + return AssertionFailure() << msg; +} + +// Constructs a failure message for Boolean assertions such as EXPECT_TRUE. +String GetBoolAssertionFailureMessage(const AssertionResult& assertion_result, + const char* expression_text, + const char* actual_predicate_value, + const char* expected_predicate_value) { + const char* actual_message = assertion_result.message(); + Message msg; + msg << "Value of: " << expression_text + << "\n Actual: " << actual_predicate_value; + if (actual_message[0] != '\0') + msg << " (" << actual_message << ")"; + msg << "\nExpected: " << expected_predicate_value; + return msg.GetString(); +} + +// Helper function for implementing ASSERT_NEAR. +AssertionResult DoubleNearPredFormat(const char* expr1, + const char* expr2, + const char* abs_error_expr, + double val1, + double val2, + double abs_error) { + const double diff = fabs(val1 - val2); + if (diff <= abs_error) return AssertionSuccess(); + + // TODO(wan): do not print the value of an expression if it's + // already a literal. + return AssertionFailure() + << "The difference between " << expr1 << " and " << expr2 + << " is " << diff << ", which exceeds " << abs_error_expr << ", where\n" + << expr1 << " evaluates to " << val1 << ",\n" + << expr2 << " evaluates to " << val2 << ", and\n" + << abs_error_expr << " evaluates to " << abs_error << "."; +} + + +// Helper template for implementing FloatLE() and DoubleLE(). +template +AssertionResult FloatingPointLE(const char* expr1, + const char* expr2, + RawType val1, + RawType val2) { + // Returns success if val1 is less than val2, + if (val1 < val2) { + return AssertionSuccess(); + } + + // or if val1 is almost equal to val2. + const FloatingPoint lhs(val1), rhs(val2); + if (lhs.AlmostEquals(rhs)) { + return AssertionSuccess(); + } + + // Note that the above two checks will both fail if either val1 or + // val2 is NaN, as the IEEE floating-point standard requires that + // any predicate involving a NaN must return false. + + ::std::stringstream val1_ss; + val1_ss << std::setprecision(std::numeric_limits::digits10 + 2) + << val1; + + ::std::stringstream val2_ss; + val2_ss << std::setprecision(std::numeric_limits::digits10 + 2) + << val2; + + return AssertionFailure() + << "Expected: (" << expr1 << ") <= (" << expr2 << ")\n" + << " Actual: " << StringStreamToString(&val1_ss) << " vs " + << StringStreamToString(&val2_ss); +} + +} // namespace internal + +// Asserts that val1 is less than, or almost equal to, val2. Fails +// otherwise. In particular, it fails if either val1 or val2 is NaN. +AssertionResult FloatLE(const char* expr1, const char* expr2, + float val1, float val2) { + return internal::FloatingPointLE(expr1, expr2, val1, val2); +} + +// Asserts that val1 is less than, or almost equal to, val2. Fails +// otherwise. In particular, it fails if either val1 or val2 is NaN. +AssertionResult DoubleLE(const char* expr1, const char* expr2, + double val1, double val2) { + return internal::FloatingPointLE(expr1, expr2, val1, val2); +} + +namespace internal { + +// The helper function for {ASSERT|EXPECT}_EQ with int or enum +// arguments. +AssertionResult CmpHelperEQ(const char* expected_expression, + const char* actual_expression, + BiggestInt expected, + BiggestInt actual) { + if (expected == actual) { + return AssertionSuccess(); + } + + return EqFailure(expected_expression, + actual_expression, + FormatForComparisonFailureMessage(expected, actual), + FormatForComparisonFailureMessage(actual, expected), + false); +} + +// A macro for implementing the helper functions needed to implement +// ASSERT_?? and EXPECT_?? with integer or enum arguments. It is here +// just to avoid copy-and-paste of similar code. +#define GTEST_IMPL_CMP_HELPER_(op_name, op)\ +AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \ + BiggestInt val1, BiggestInt val2) {\ + if (val1 op val2) {\ + return AssertionSuccess();\ + } else {\ + return AssertionFailure() \ + << "Expected: (" << expr1 << ") " #op " (" << expr2\ + << "), actual: " << FormatForComparisonFailureMessage(val1, val2)\ + << " vs " << FormatForComparisonFailureMessage(val2, val1);\ + }\ +} + +// Implements the helper function for {ASSERT|EXPECT}_NE with int or +// enum arguments. +GTEST_IMPL_CMP_HELPER_(NE, !=) +// Implements the helper function for {ASSERT|EXPECT}_LE with int or +// enum arguments. +GTEST_IMPL_CMP_HELPER_(LE, <=) +// Implements the helper function for {ASSERT|EXPECT}_LT with int or +// enum arguments. +GTEST_IMPL_CMP_HELPER_(LT, < ) +// Implements the helper function for {ASSERT|EXPECT}_GE with int or +// enum arguments. +GTEST_IMPL_CMP_HELPER_(GE, >=) +// Implements the helper function for {ASSERT|EXPECT}_GT with int or +// enum arguments. +GTEST_IMPL_CMP_HELPER_(GT, > ) + +#undef GTEST_IMPL_CMP_HELPER_ + +// The helper function for {ASSERT|EXPECT}_STREQ. +AssertionResult CmpHelperSTREQ(const char* expected_expression, + const char* actual_expression, + const char* expected, + const char* actual) { + if (String::CStringEquals(expected, actual)) { + return AssertionSuccess(); + } + + return EqFailure(expected_expression, + actual_expression, + String::ShowCStringQuoted(expected), + String::ShowCStringQuoted(actual), + false); +} + +// The helper function for {ASSERT|EXPECT}_STRCASEEQ. +AssertionResult CmpHelperSTRCASEEQ(const char* expected_expression, + const char* actual_expression, + const char* expected, + const char* actual) { + if (String::CaseInsensitiveCStringEquals(expected, actual)) { + return AssertionSuccess(); + } + + return EqFailure(expected_expression, + actual_expression, + String::ShowCStringQuoted(expected), + String::ShowCStringQuoted(actual), + true); +} + +// The helper function for {ASSERT|EXPECT}_STRNE. +AssertionResult CmpHelperSTRNE(const char* s1_expression, + const char* s2_expression, + const char* s1, + const char* s2) { + if (!String::CStringEquals(s1, s2)) { + return AssertionSuccess(); + } else { + return AssertionFailure() << "Expected: (" << s1_expression << ") != (" + << s2_expression << "), actual: \"" + << s1 << "\" vs \"" << s2 << "\""; + } +} + +// The helper function for {ASSERT|EXPECT}_STRCASENE. +AssertionResult CmpHelperSTRCASENE(const char* s1_expression, + const char* s2_expression, + const char* s1, + const char* s2) { + if (!String::CaseInsensitiveCStringEquals(s1, s2)) { + return AssertionSuccess(); + } else { + return AssertionFailure() + << "Expected: (" << s1_expression << ") != (" + << s2_expression << ") (ignoring case), actual: \"" + << s1 << "\" vs \"" << s2 << "\""; + } +} + +} // namespace internal + +namespace { + +// Helper functions for implementing IsSubString() and IsNotSubstring(). + +// This group of overloaded functions return true iff needle is a +// substring of haystack. NULL is considered a substring of itself +// only. + +bool IsSubstringPred(const char* needle, const char* haystack) { + if (needle == NULL || haystack == NULL) + return needle == haystack; + + return strstr(haystack, needle) != NULL; +} + +bool IsSubstringPred(const wchar_t* needle, const wchar_t* haystack) { + if (needle == NULL || haystack == NULL) + return needle == haystack; + + return wcsstr(haystack, needle) != NULL; +} + +// StringType here can be either ::std::string or ::std::wstring. +template +bool IsSubstringPred(const StringType& needle, + const StringType& haystack) { + return haystack.find(needle) != StringType::npos; +} + +// This function implements either IsSubstring() or IsNotSubstring(), +// depending on the value of the expected_to_be_substring parameter. +// StringType here can be const char*, const wchar_t*, ::std::string, +// or ::std::wstring. +template +AssertionResult IsSubstringImpl( + bool expected_to_be_substring, + const char* needle_expr, const char* haystack_expr, + const StringType& needle, const StringType& haystack) { + if (IsSubstringPred(needle, haystack) == expected_to_be_substring) + return AssertionSuccess(); + + const bool is_wide_string = sizeof(needle[0]) > 1; + const char* const begin_string_quote = is_wide_string ? "L\"" : "\""; + return AssertionFailure() + << "Value of: " << needle_expr << "\n" + << " Actual: " << begin_string_quote << needle << "\"\n" + << "Expected: " << (expected_to_be_substring ? "" : "not ") + << "a substring of " << haystack_expr << "\n" + << "Which is: " << begin_string_quote << haystack << "\""; +} + +} // namespace + +// IsSubstring() and IsNotSubstring() check whether needle is a +// substring of haystack (NULL is considered a substring of itself +// only), and return an appropriate error message when they fail. + +AssertionResult IsSubstring( + const char* needle_expr, const char* haystack_expr, + const char* needle, const char* haystack) { + return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack); +} + +AssertionResult IsSubstring( + const char* needle_expr, const char* haystack_expr, + const wchar_t* needle, const wchar_t* haystack) { + return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack); +} + +AssertionResult IsNotSubstring( + const char* needle_expr, const char* haystack_expr, + const char* needle, const char* haystack) { + return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack); +} + +AssertionResult IsNotSubstring( + const char* needle_expr, const char* haystack_expr, + const wchar_t* needle, const wchar_t* haystack) { + return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack); +} + +AssertionResult IsSubstring( + const char* needle_expr, const char* haystack_expr, + const ::std::string& needle, const ::std::string& haystack) { + return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack); +} + +AssertionResult IsNotSubstring( + const char* needle_expr, const char* haystack_expr, + const ::std::string& needle, const ::std::string& haystack) { + return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack); +} + +#if GTEST_HAS_STD_WSTRING +AssertionResult IsSubstring( + const char* needle_expr, const char* haystack_expr, + const ::std::wstring& needle, const ::std::wstring& haystack) { + return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack); +} + +AssertionResult IsNotSubstring( + const char* needle_expr, const char* haystack_expr, + const ::std::wstring& needle, const ::std::wstring& haystack) { + return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack); +} +#endif // GTEST_HAS_STD_WSTRING + +namespace internal { + +#if GTEST_OS_WINDOWS + +namespace { + +// Helper function for IsHRESULT{SuccessFailure} predicates +AssertionResult HRESULTFailureHelper(const char* expr, + const char* expected, + long hr) { // NOLINT +# if GTEST_OS_WINDOWS_MOBILE + + // Windows CE doesn't support FormatMessage. + const char error_text[] = ""; + +# else + + // Looks up the human-readable system message for the HRESULT code + // and since we're not passing any params to FormatMessage, we don't + // want inserts expanded. + const DWORD kFlags = FORMAT_MESSAGE_FROM_SYSTEM | + FORMAT_MESSAGE_IGNORE_INSERTS; + const DWORD kBufSize = 4096; // String::Format can't exceed this length. + // Gets the system's human readable message string for this HRESULT. + char error_text[kBufSize] = { '\0' }; + DWORD message_length = ::FormatMessageA(kFlags, + 0, // no source, we're asking system + hr, // the error + 0, // no line width restrictions + error_text, // output buffer + kBufSize, // buf size + NULL); // no arguments for inserts + // Trims tailing white space (FormatMessage leaves a trailing cr-lf) + for (; message_length && IsSpace(error_text[message_length - 1]); + --message_length) { + error_text[message_length - 1] = '\0'; + } + +# endif // GTEST_OS_WINDOWS_MOBILE + + const String error_hex(String::Format("0x%08X ", hr)); + return ::testing::AssertionFailure() + << "Expected: " << expr << " " << expected << ".\n" + << " Actual: " << error_hex << error_text << "\n"; +} + +} // namespace + +AssertionResult IsHRESULTSuccess(const char* expr, long hr) { // NOLINT + if (SUCCEEDED(hr)) { + return AssertionSuccess(); + } + return HRESULTFailureHelper(expr, "succeeds", hr); +} + +AssertionResult IsHRESULTFailure(const char* expr, long hr) { // NOLINT + if (FAILED(hr)) { + return AssertionSuccess(); + } + return HRESULTFailureHelper(expr, "fails", hr); +} + +#endif // GTEST_OS_WINDOWS + +// Utility functions for encoding Unicode text (wide strings) in +// UTF-8. + +// A Unicode code-point can have upto 21 bits, and is encoded in UTF-8 +// like this: +// +// Code-point length Encoding +// 0 - 7 bits 0xxxxxxx +// 8 - 11 bits 110xxxxx 10xxxxxx +// 12 - 16 bits 1110xxxx 10xxxxxx 10xxxxxx +// 17 - 21 bits 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx + +// The maximum code-point a one-byte UTF-8 sequence can represent. +const UInt32 kMaxCodePoint1 = (static_cast(1) << 7) - 1; + +// The maximum code-point a two-byte UTF-8 sequence can represent. +const UInt32 kMaxCodePoint2 = (static_cast(1) << (5 + 6)) - 1; + +// The maximum code-point a three-byte UTF-8 sequence can represent. +const UInt32 kMaxCodePoint3 = (static_cast(1) << (4 + 2*6)) - 1; + +// The maximum code-point a four-byte UTF-8 sequence can represent. +const UInt32 kMaxCodePoint4 = (static_cast(1) << (3 + 3*6)) - 1; + +// Chops off the n lowest bits from a bit pattern. Returns the n +// lowest bits. As a side effect, the original bit pattern will be +// shifted to the right by n bits. +inline UInt32 ChopLowBits(UInt32* bits, int n) { + const UInt32 low_bits = *bits & ((static_cast(1) << n) - 1); + *bits >>= n; + return low_bits; +} + +// Converts a Unicode code point to a narrow string in UTF-8 encoding. +// code_point parameter is of type UInt32 because wchar_t may not be +// wide enough to contain a code point. +// The output buffer str must containt at least 32 characters. +// The function returns the address of the output buffer. +// If the code_point is not a valid Unicode code point +// (i.e. outside of Unicode range U+0 to U+10FFFF) it will be output +// as '(Invalid Unicode 0xXXXXXXXX)'. +char* CodePointToUtf8(UInt32 code_point, char* str) { + if (code_point <= kMaxCodePoint1) { + str[1] = '\0'; + str[0] = static_cast(code_point); // 0xxxxxxx + } else if (code_point <= kMaxCodePoint2) { + str[2] = '\0'; + str[1] = static_cast(0x80 | ChopLowBits(&code_point, 6)); // 10xxxxxx + str[0] = static_cast(0xC0 | code_point); // 110xxxxx + } else if (code_point <= kMaxCodePoint3) { + str[3] = '\0'; + str[2] = static_cast(0x80 | ChopLowBits(&code_point, 6)); // 10xxxxxx + str[1] = static_cast(0x80 | ChopLowBits(&code_point, 6)); // 10xxxxxx + str[0] = static_cast(0xE0 | code_point); // 1110xxxx + } else if (code_point <= kMaxCodePoint4) { + str[4] = '\0'; + str[3] = static_cast(0x80 | ChopLowBits(&code_point, 6)); // 10xxxxxx + str[2] = static_cast(0x80 | ChopLowBits(&code_point, 6)); // 10xxxxxx + str[1] = static_cast(0x80 | ChopLowBits(&code_point, 6)); // 10xxxxxx + str[0] = static_cast(0xF0 | code_point); // 11110xxx + } else { + // The longest string String::Format can produce when invoked + // with these parameters is 28 character long (not including + // the terminating nul character). We are asking for 32 character + // buffer just in case. This is also enough for strncpy to + // null-terminate the destination string. + posix::StrNCpy( + str, String::Format("(Invalid Unicode 0x%X)", code_point).c_str(), 32); + str[31] = '\0'; // Makes sure no change in the format to strncpy leaves + // the result unterminated. + } + return str; +} + +// The following two functions only make sense if the the system +// uses UTF-16 for wide string encoding. All supported systems +// with 16 bit wchar_t (Windows, Cygwin, Symbian OS) do use UTF-16. + +// Determines if the arguments constitute UTF-16 surrogate pair +// and thus should be combined into a single Unicode code point +// using CreateCodePointFromUtf16SurrogatePair. +inline bool IsUtf16SurrogatePair(wchar_t first, wchar_t second) { + return sizeof(wchar_t) == 2 && + (first & 0xFC00) == 0xD800 && (second & 0xFC00) == 0xDC00; +} + +// Creates a Unicode code point from UTF16 surrogate pair. +inline UInt32 CreateCodePointFromUtf16SurrogatePair(wchar_t first, + wchar_t second) { + const UInt32 mask = (1 << 10) - 1; + return (sizeof(wchar_t) == 2) ? + (((first & mask) << 10) | (second & mask)) + 0x10000 : + // This function should not be called when the condition is + // false, but we provide a sensible default in case it is. + static_cast(first); +} + +// Converts a wide string to a narrow string in UTF-8 encoding. +// The wide string is assumed to have the following encoding: +// UTF-16 if sizeof(wchar_t) == 2 (on Windows, Cygwin, Symbian OS) +// UTF-32 if sizeof(wchar_t) == 4 (on Linux) +// Parameter str points to a null-terminated wide string. +// Parameter num_chars may additionally limit the number +// of wchar_t characters processed. -1 is used when the entire string +// should be processed. +// If the string contains code points that are not valid Unicode code points +// (i.e. outside of Unicode range U+0 to U+10FFFF) they will be output +// as '(Invalid Unicode 0xXXXXXXXX)'. If the string is in UTF16 encoding +// and contains invalid UTF-16 surrogate pairs, values in those pairs +// will be encoded as individual Unicode characters from Basic Normal Plane. +String WideStringToUtf8(const wchar_t* str, int num_chars) { + if (num_chars == -1) + num_chars = static_cast(wcslen(str)); + + ::std::stringstream stream; + for (int i = 0; i < num_chars; ++i) { + UInt32 unicode_code_point; + + if (str[i] == L'\0') { + break; + } else if (i + 1 < num_chars && IsUtf16SurrogatePair(str[i], str[i + 1])) { + unicode_code_point = CreateCodePointFromUtf16SurrogatePair(str[i], + str[i + 1]); + i++; + } else { + unicode_code_point = static_cast(str[i]); + } + + char buffer[32]; // CodePointToUtf8 requires a buffer this big. + stream << CodePointToUtf8(unicode_code_point, buffer); + } + return StringStreamToString(&stream); +} + +// Converts a wide C string to a String using the UTF-8 encoding. +// NULL will be converted to "(null)". +String String::ShowWideCString(const wchar_t * wide_c_str) { + if (wide_c_str == NULL) return String("(null)"); + + return String(internal::WideStringToUtf8(wide_c_str, -1).c_str()); +} + +// Similar to ShowWideCString(), except that this function encloses +// the converted string in double quotes. +String String::ShowWideCStringQuoted(const wchar_t* wide_c_str) { + if (wide_c_str == NULL) return String("(null)"); + + return String::Format("L\"%s\"", + String::ShowWideCString(wide_c_str).c_str()); +} + +// Compares two wide C strings. Returns true iff they have the same +// content. +// +// Unlike wcscmp(), this function can handle NULL argument(s). A NULL +// C string is considered different to any non-NULL C string, +// including the empty string. +bool String::WideCStringEquals(const wchar_t * lhs, const wchar_t * rhs) { + if (lhs == NULL) return rhs == NULL; + + if (rhs == NULL) return false; + + return wcscmp(lhs, rhs) == 0; +} + +// Helper function for *_STREQ on wide strings. +AssertionResult CmpHelperSTREQ(const char* expected_expression, + const char* actual_expression, + const wchar_t* expected, + const wchar_t* actual) { + if (String::WideCStringEquals(expected, actual)) { + return AssertionSuccess(); + } + + return EqFailure(expected_expression, + actual_expression, + String::ShowWideCStringQuoted(expected), + String::ShowWideCStringQuoted(actual), + false); +} + +// Helper function for *_STRNE on wide strings. +AssertionResult CmpHelperSTRNE(const char* s1_expression, + const char* s2_expression, + const wchar_t* s1, + const wchar_t* s2) { + if (!String::WideCStringEquals(s1, s2)) { + return AssertionSuccess(); + } + + return AssertionFailure() << "Expected: (" << s1_expression << ") != (" + << s2_expression << "), actual: " + << String::ShowWideCStringQuoted(s1) + << " vs " << String::ShowWideCStringQuoted(s2); +} + +// Compares two C strings, ignoring case. Returns true iff they have +// the same content. +// +// Unlike strcasecmp(), this function can handle NULL argument(s). A +// NULL C string is considered different to any non-NULL C string, +// including the empty string. +bool String::CaseInsensitiveCStringEquals(const char * lhs, const char * rhs) { + if (lhs == NULL) + return rhs == NULL; + if (rhs == NULL) + return false; + return posix::StrCaseCmp(lhs, rhs) == 0; +} + + // Compares two wide C strings, ignoring case. Returns true iff they + // have the same content. + // + // Unlike wcscasecmp(), this function can handle NULL argument(s). + // A NULL C string is considered different to any non-NULL wide C string, + // including the empty string. + // NB: The implementations on different platforms slightly differ. + // On windows, this method uses _wcsicmp which compares according to LC_CTYPE + // environment variable. On GNU platform this method uses wcscasecmp + // which compares according to LC_CTYPE category of the current locale. + // On MacOS X, it uses towlower, which also uses LC_CTYPE category of the + // current locale. +bool String::CaseInsensitiveWideCStringEquals(const wchar_t* lhs, + const wchar_t* rhs) { + if (lhs == NULL) return rhs == NULL; + + if (rhs == NULL) return false; + +#if GTEST_OS_WINDOWS + return _wcsicmp(lhs, rhs) == 0; +#elif GTEST_OS_LINUX && !GTEST_OS_LINUX_ANDROID + return wcscasecmp(lhs, rhs) == 0; +#else + // Android, Mac OS X and Cygwin don't define wcscasecmp. + // Other unknown OSes may not define it either. + wint_t left, right; + do { + left = towlower(*lhs++); + right = towlower(*rhs++); + } while (left && left == right); + return left == right; +#endif // OS selector +} + +// Compares this with another String. +// Returns < 0 if this is less than rhs, 0 if this is equal to rhs, or > 0 +// if this is greater than rhs. +int String::Compare(const String & rhs) const { + const char* const lhs_c_str = c_str(); + const char* const rhs_c_str = rhs.c_str(); + + if (lhs_c_str == NULL) { + return rhs_c_str == NULL ? 0 : -1; // NULL < anything except NULL + } else if (rhs_c_str == NULL) { + return 1; + } + + const size_t shorter_str_len = + length() <= rhs.length() ? length() : rhs.length(); + for (size_t i = 0; i != shorter_str_len; i++) { + if (lhs_c_str[i] < rhs_c_str[i]) { + return -1; + } else if (lhs_c_str[i] > rhs_c_str[i]) { + return 1; + } + } + return (length() < rhs.length()) ? -1 : + (length() > rhs.length()) ? 1 : 0; +} + +// Returns true iff this String ends with the given suffix. *Any* +// String is considered to end with a NULL or empty suffix. +bool String::EndsWith(const char* suffix) const { + if (suffix == NULL || CStringEquals(suffix, "")) return true; + + if (c_str() == NULL) return false; + + const size_t this_len = strlen(c_str()); + const size_t suffix_len = strlen(suffix); + return (this_len >= suffix_len) && + CStringEquals(c_str() + this_len - suffix_len, suffix); +} + +// Returns true iff this String ends with the given suffix, ignoring case. +// Any String is considered to end with a NULL or empty suffix. +bool String::EndsWithCaseInsensitive(const char* suffix) const { + if (suffix == NULL || CStringEquals(suffix, "")) return true; + + if (c_str() == NULL) return false; + + const size_t this_len = strlen(c_str()); + const size_t suffix_len = strlen(suffix); + return (this_len >= suffix_len) && + CaseInsensitiveCStringEquals(c_str() + this_len - suffix_len, suffix); +} + +// Formats a list of arguments to a String, using the same format +// spec string as for printf. +// +// We do not use the StringPrintf class as it is not universally +// available. +// +// The result is limited to 4096 characters (including the tailing 0). +// If 4096 characters are not enough to format the input, or if +// there's an error, "" is +// returned. +String String::Format(const char * format, ...) { + va_list args; + va_start(args, format); + + char buffer[4096]; + const int kBufferSize = sizeof(buffer)/sizeof(buffer[0]); + + // MSVC 8 deprecates vsnprintf(), so we want to suppress warning + // 4996 (deprecated function) there. +#ifdef _MSC_VER // We are using MSVC. +# pragma warning(push) // Saves the current warning state. +# pragma warning(disable:4996) // Temporarily disables warning 4996. + + const int size = vsnprintf(buffer, kBufferSize, format, args); + +# pragma warning(pop) // Restores the warning state. +#else // We are not using MSVC. + const int size = vsnprintf(buffer, kBufferSize, format, args); +#endif // _MSC_VER + va_end(args); + + // vsnprintf()'s behavior is not portable. When the buffer is not + // big enough, it returns a negative value in MSVC, and returns the + // needed buffer size on Linux. When there is an output error, it + // always returns a negative value. For simplicity, we lump the two + // error cases together. + if (size < 0 || size >= kBufferSize) { + return String(""); + } else { + return String(buffer, size); + } +} + +// Converts the buffer in a stringstream to a String, converting NUL +// bytes to "\\0" along the way. +String StringStreamToString(::std::stringstream* ss) { + const ::std::string& str = ss->str(); + const char* const start = str.c_str(); + const char* const end = start + str.length(); + + // We need to use a helper stringstream to do this transformation + // because String doesn't support push_back(). + ::std::stringstream helper; + for (const char* ch = start; ch != end; ++ch) { + if (*ch == '\0') { + helper << "\\0"; // Replaces NUL with "\\0"; + } else { + helper.put(*ch); + } + } + + return String(helper.str().c_str()); +} + +// Appends the user-supplied message to the Google-Test-generated message. +String AppendUserMessage(const String& gtest_msg, + const Message& user_msg) { + // Appends the user message if it's non-empty. + const String user_msg_string = user_msg.GetString(); + if (user_msg_string.empty()) { + return gtest_msg; + } + + Message msg; + msg << gtest_msg << "\n" << user_msg_string; + + return msg.GetString(); +} + +} // namespace internal + +// class TestResult + +// Creates an empty TestResult. +TestResult::TestResult() + : death_test_count_(0), + elapsed_time_(0) { +} + +// D'tor. +TestResult::~TestResult() { +} + +// Returns the i-th test part result among all the results. i can +// range from 0 to total_part_count() - 1. If i is not in that range, +// aborts the program. +const TestPartResult& TestResult::GetTestPartResult(int i) const { + if (i < 0 || i >= total_part_count()) + internal::posix::Abort(); + return test_part_results_.at(i); +} + +// Returns the i-th test property. i can range from 0 to +// test_property_count() - 1. If i is not in that range, aborts the +// program. +const TestProperty& TestResult::GetTestProperty(int i) const { + if (i < 0 || i >= test_property_count()) + internal::posix::Abort(); + return test_properties_.at(i); +} + +// Clears the test part results. +void TestResult::ClearTestPartResults() { + test_part_results_.clear(); +} + +// Adds a test part result to the list. +void TestResult::AddTestPartResult(const TestPartResult& test_part_result) { + test_part_results_.push_back(test_part_result); +} + +// Adds a test property to the list. If a property with the same key as the +// supplied property is already represented, the value of this test_property +// replaces the old value for that key. +void TestResult::RecordProperty(const TestProperty& test_property) { + if (!ValidateTestProperty(test_property)) { + return; + } + internal::MutexLock lock(&test_properites_mutex_); + const std::vector::iterator property_with_matching_key = + std::find_if(test_properties_.begin(), test_properties_.end(), + internal::TestPropertyKeyIs(test_property.key())); + if (property_with_matching_key == test_properties_.end()) { + test_properties_.push_back(test_property); + return; + } + property_with_matching_key->SetValue(test_property.value()); +} + +// Adds a failure if the key is a reserved attribute of Google Test +// testcase tags. Returns true if the property is valid. +bool TestResult::ValidateTestProperty(const TestProperty& test_property) { + internal::String key(test_property.key()); + if (key == "name" || key == "status" || key == "time" || key == "classname") { + ADD_FAILURE() + << "Reserved key used in RecordProperty(): " + << key + << " ('name', 'status', 'time', and 'classname' are reserved by " + << GTEST_NAME_ << ")"; + return false; + } + return true; +} + +// Clears the object. +void TestResult::Clear() { + test_part_results_.clear(); + test_properties_.clear(); + death_test_count_ = 0; + elapsed_time_ = 0; +} + +// Returns true iff the test failed. +bool TestResult::Failed() const { + for (int i = 0; i < total_part_count(); ++i) { + if (GetTestPartResult(i).failed()) + return true; + } + return false; +} + +// Returns true iff the test part fatally failed. +static bool TestPartFatallyFailed(const TestPartResult& result) { + return result.fatally_failed(); +} + +// Returns true iff the test fatally failed. +bool TestResult::HasFatalFailure() const { + return CountIf(test_part_results_, TestPartFatallyFailed) > 0; +} + +// Returns true iff the test part non-fatally failed. +static bool TestPartNonfatallyFailed(const TestPartResult& result) { + return result.nonfatally_failed(); +} + +// Returns true iff the test has a non-fatal failure. +bool TestResult::HasNonfatalFailure() const { + return CountIf(test_part_results_, TestPartNonfatallyFailed) > 0; +} + +// Gets the number of all test parts. This is the sum of the number +// of successful test parts and the number of failed test parts. +int TestResult::total_part_count() const { + return static_cast(test_part_results_.size()); +} + +// Returns the number of the test properties. +int TestResult::test_property_count() const { + return static_cast(test_properties_.size()); +} + +// class Test + +// Creates a Test object. + +// The c'tor saves the values of all Google Test flags. +Test::Test() + : gtest_flag_saver_(new internal::GTestFlagSaver) { +} + +// The d'tor restores the values of all Google Test flags. +Test::~Test() { + delete gtest_flag_saver_; +} + +// Sets up the test fixture. +// +// A sub-class may override this. +void Test::SetUp() { +} + +// Tears down the test fixture. +// +// A sub-class may override this. +void Test::TearDown() { +} + +// Allows user supplied key value pairs to be recorded for later output. +void Test::RecordProperty(const char* key, const char* value) { + UnitTest::GetInstance()->RecordPropertyForCurrentTest(key, value); +} + +// Allows user supplied key value pairs to be recorded for later output. +void Test::RecordProperty(const char* key, int value) { + Message value_message; + value_message << value; + RecordProperty(key, value_message.GetString().c_str()); +} + +namespace internal { + +void ReportFailureInUnknownLocation(TestPartResult::Type result_type, + const String& message) { + // This function is a friend of UnitTest and as such has access to + // AddTestPartResult. + UnitTest::GetInstance()->AddTestPartResult( + result_type, + NULL, // No info about the source file where the exception occurred. + -1, // We have no info on which line caused the exception. + message, + String()); // No stack trace, either. +} + +} // namespace internal + +// Google Test requires all tests in the same test case to use the same test +// fixture class. This function checks if the current test has the +// same fixture class as the first test in the current test case. If +// yes, it returns true; otherwise it generates a Google Test failure and +// returns false. +bool Test::HasSameFixtureClass() { + internal::UnitTestImpl* const impl = internal::GetUnitTestImpl(); + const TestCase* const test_case = impl->current_test_case(); + + // Info about the first test in the current test case. + const TestInfo* const first_test_info = test_case->test_info_list()[0]; + const internal::TypeId first_fixture_id = first_test_info->fixture_class_id_; + const char* const first_test_name = first_test_info->name(); + + // Info about the current test. + const TestInfo* const this_test_info = impl->current_test_info(); + const internal::TypeId this_fixture_id = this_test_info->fixture_class_id_; + const char* const this_test_name = this_test_info->name(); + + if (this_fixture_id != first_fixture_id) { + // Is the first test defined using TEST? + const bool first_is_TEST = first_fixture_id == internal::GetTestTypeId(); + // Is this test defined using TEST? + const bool this_is_TEST = this_fixture_id == internal::GetTestTypeId(); + + if (first_is_TEST || this_is_TEST) { + // The user mixed TEST and TEST_F in this test case - we'll tell + // him/her how to fix it. + + // Gets the name of the TEST and the name of the TEST_F. Note + // that first_is_TEST and this_is_TEST cannot both be true, as + // the fixture IDs are different for the two tests. + const char* const TEST_name = + first_is_TEST ? first_test_name : this_test_name; + const char* const TEST_F_name = + first_is_TEST ? this_test_name : first_test_name; + + ADD_FAILURE() + << "All tests in the same test case must use the same test fixture\n" + << "class, so mixing TEST_F and TEST in the same test case is\n" + << "illegal. In test case " << this_test_info->test_case_name() + << ",\n" + << "test " << TEST_F_name << " is defined using TEST_F but\n" + << "test " << TEST_name << " is defined using TEST. You probably\n" + << "want to change the TEST to TEST_F or move it to another test\n" + << "case."; + } else { + // The user defined two fixture classes with the same name in + // two namespaces - we'll tell him/her how to fix it. + ADD_FAILURE() + << "All tests in the same test case must use the same test fixture\n" + << "class. However, in test case " + << this_test_info->test_case_name() << ",\n" + << "you defined test " << first_test_name + << " and test " << this_test_name << "\n" + << "using two different test fixture classes. This can happen if\n" + << "the two classes are from different namespaces or translation\n" + << "units and have the same name. You should probably rename one\n" + << "of the classes to put the tests into different test cases."; + } + return false; + } + + return true; +} + +#if GTEST_HAS_SEH + +// Adds an "exception thrown" fatal failure to the current test. This +// function returns its result via an output parameter pointer because VC++ +// prohibits creation of objects with destructors on stack in functions +// using __try (see error C2712). +static internal::String* FormatSehExceptionMessage(DWORD exception_code, + const char* location) { + Message message; + message << "SEH exception with code 0x" << std::setbase(16) << + exception_code << std::setbase(10) << " thrown in " << location << "."; + + return new internal::String(message.GetString()); +} + +#endif // GTEST_HAS_SEH + +#if GTEST_HAS_EXCEPTIONS + +// Adds an "exception thrown" fatal failure to the current test. +static internal::String FormatCxxExceptionMessage(const char* description, + const char* location) { + Message message; + if (description != NULL) { + message << "C++ exception with description \"" << description << "\""; + } else { + message << "Unknown C++ exception"; + } + message << " thrown in " << location << "."; + + return message.GetString(); +} + +static internal::String PrintTestPartResultToString( + const TestPartResult& test_part_result); + +// A failed Google Test assertion will throw an exception of this type when +// GTEST_FLAG(throw_on_failure) is true (if exceptions are enabled). We +// derive it from std::runtime_error, which is for errors presumably +// detectable only at run time. Since std::runtime_error inherits from +// std::exception, many testing frameworks know how to extract and print the +// message inside it. +class GoogleTestFailureException : public ::std::runtime_error { + public: + explicit GoogleTestFailureException(const TestPartResult& failure) + : ::std::runtime_error(PrintTestPartResultToString(failure).c_str()) {} +}; +#endif // GTEST_HAS_EXCEPTIONS + +namespace internal { +// We put these helper functions in the internal namespace as IBM's xlC +// compiler rejects the code if they were declared static. + +// Runs the given method and handles SEH exceptions it throws, when +// SEH is supported; returns the 0-value for type Result in case of an +// SEH exception. (Microsoft compilers cannot handle SEH and C++ +// exceptions in the same function. Therefore, we provide a separate +// wrapper function for handling SEH exceptions.) +template +Result HandleSehExceptionsInMethodIfSupported( + T* object, Result (T::*method)(), const char* location) { +#if GTEST_HAS_SEH + __try { + return (object->*method)(); + } __except (internal::UnitTestOptions::GTestShouldProcessSEH( // NOLINT + GetExceptionCode())) { + // We create the exception message on the heap because VC++ prohibits + // creation of objects with destructors on stack in functions using __try + // (see error C2712). + internal::String* exception_message = FormatSehExceptionMessage( + GetExceptionCode(), location); + internal::ReportFailureInUnknownLocation(TestPartResult::kFatalFailure, + *exception_message); + delete exception_message; + return static_cast(0); + } +#else + (void)location; + return (object->*method)(); +#endif // GTEST_HAS_SEH +} + +// Runs the given method and catches and reports C++ and/or SEH-style +// exceptions, if they are supported; returns the 0-value for type +// Result in case of an SEH exception. +template +Result HandleExceptionsInMethodIfSupported( + T* object, Result (T::*method)(), const char* location) { + // NOTE: The user code can affect the way in which Google Test handles + // exceptions by setting GTEST_FLAG(catch_exceptions), but only before + // RUN_ALL_TESTS() starts. It is technically possible to check the flag + // after the exception is caught and either report or re-throw the + // exception based on the flag's value: + // + // try { + // // Perform the test method. + // } catch (...) { + // if (GTEST_FLAG(catch_exceptions)) + // // Report the exception as failure. + // else + // throw; // Re-throws the original exception. + // } + // + // However, the purpose of this flag is to allow the program to drop into + // the debugger when the exception is thrown. On most platforms, once the + // control enters the catch block, the exception origin information is + // lost and the debugger will stop the program at the point of the + // re-throw in this function -- instead of at the point of the original + // throw statement in the code under test. For this reason, we perform + // the check early, sacrificing the ability to affect Google Test's + // exception handling in the method where the exception is thrown. + if (internal::GetUnitTestImpl()->catch_exceptions()) { +#if GTEST_HAS_EXCEPTIONS + try { + return HandleSehExceptionsInMethodIfSupported(object, method, location); + } catch (const GoogleTestFailureException&) { // NOLINT + // This exception doesn't originate in code under test. It makes no + // sense to report it as a test failure. + throw; + } catch (const std::exception& e) { // NOLINT + internal::ReportFailureInUnknownLocation( + TestPartResult::kFatalFailure, + FormatCxxExceptionMessage(e.what(), location)); + } catch (...) { // NOLINT + internal::ReportFailureInUnknownLocation( + TestPartResult::kFatalFailure, + FormatCxxExceptionMessage(NULL, location)); + } + return static_cast(0); +#else + return HandleSehExceptionsInMethodIfSupported(object, method, location); +#endif // GTEST_HAS_EXCEPTIONS + } else { + return (object->*method)(); + } +} + +} // namespace internal + +// Runs the test and updates the test result. +void Test::Run() { + if (!HasSameFixtureClass()) return; + + internal::UnitTestImpl* const impl = internal::GetUnitTestImpl(); + impl->os_stack_trace_getter()->UponLeavingGTest(); + internal::HandleExceptionsInMethodIfSupported(this, &Test::SetUp, "SetUp()"); + // We will run the test only if SetUp() was successful. + if (!HasFatalFailure()) { + impl->os_stack_trace_getter()->UponLeavingGTest(); + internal::HandleExceptionsInMethodIfSupported( + this, &Test::TestBody, "the test body"); + } + + // However, we want to clean up as much as possible. Hence we will + // always call TearDown(), even if SetUp() or the test body has + // failed. + impl->os_stack_trace_getter()->UponLeavingGTest(); + internal::HandleExceptionsInMethodIfSupported( + this, &Test::TearDown, "TearDown()"); +} + +// Returns true iff the current test has a fatal failure. +bool Test::HasFatalFailure() { + return internal::GetUnitTestImpl()->current_test_result()->HasFatalFailure(); +} + +// Returns true iff the current test has a non-fatal failure. +bool Test::HasNonfatalFailure() { + return internal::GetUnitTestImpl()->current_test_result()-> + HasNonfatalFailure(); +} + +// class TestInfo + +// Constructs a TestInfo object. It assumes ownership of the test factory +// object. +// TODO(vladl@google.com): Make a_test_case_name and a_name const string&'s +// to signify they cannot be NULLs. +TestInfo::TestInfo(const char* a_test_case_name, + const char* a_name, + const char* a_type_param, + const char* a_value_param, + internal::TypeId fixture_class_id, + internal::TestFactoryBase* factory) + : test_case_name_(a_test_case_name), + name_(a_name), + type_param_(a_type_param ? new std::string(a_type_param) : NULL), + value_param_(a_value_param ? new std::string(a_value_param) : NULL), + fixture_class_id_(fixture_class_id), + should_run_(false), + is_disabled_(false), + matches_filter_(false), + factory_(factory), + result_() {} + +// Destructs a TestInfo object. +TestInfo::~TestInfo() { delete factory_; } + +namespace internal { + +// Creates a new TestInfo object and registers it with Google Test; +// returns the created object. +// +// Arguments: +// +// test_case_name: name of the test case +// name: name of the test +// type_param: the name of the test's type parameter, or NULL if +// this is not a typed or a type-parameterized test. +// value_param: text representation of the test's value parameter, +// or NULL if this is not a value-parameterized test. +// fixture_class_id: ID of the test fixture class +// set_up_tc: pointer to the function that sets up the test case +// tear_down_tc: pointer to the function that tears down the test case +// factory: pointer to the factory that creates a test object. +// The newly created TestInfo instance will assume +// ownership of the factory object. +TestInfo* MakeAndRegisterTestInfo( + const char* test_case_name, const char* name, + const char* type_param, + const char* value_param, + TypeId fixture_class_id, + SetUpTestCaseFunc set_up_tc, + TearDownTestCaseFunc tear_down_tc, + TestFactoryBase* factory) { + TestInfo* const test_info = + new TestInfo(test_case_name, name, type_param, value_param, + fixture_class_id, factory); + GetUnitTestImpl()->AddTestInfo(set_up_tc, tear_down_tc, test_info); + return test_info; +} + +#if GTEST_HAS_PARAM_TEST +void ReportInvalidTestCaseType(const char* test_case_name, + const char* file, int line) { + Message errors; + errors + << "Attempted redefinition of test case " << test_case_name << ".\n" + << "All tests in the same test case must use the same test fixture\n" + << "class. However, in test case " << test_case_name << ", you tried\n" + << "to define a test using a fixture class different from the one\n" + << "used earlier. This can happen if the two fixture classes are\n" + << "from different namespaces and have the same name. You should\n" + << "probably rename one of the classes to put the tests into different\n" + << "test cases."; + + fprintf(stderr, "%s %s", FormatFileLocation(file, line).c_str(), + errors.GetString().c_str()); +} +#endif // GTEST_HAS_PARAM_TEST + +} // namespace internal + +namespace { + +// A predicate that checks the test name of a TestInfo against a known +// value. +// +// This is used for implementation of the TestCase class only. We put +// it in the anonymous namespace to prevent polluting the outer +// namespace. +// +// TestNameIs is copyable. +class TestNameIs { + public: + // Constructor. + // + // TestNameIs has NO default constructor. + explicit TestNameIs(const char* name) + : name_(name) {} + + // Returns true iff the test name of test_info matches name_. + bool operator()(const TestInfo * test_info) const { + return test_info && internal::String(test_info->name()).Compare(name_) == 0; + } + + private: + internal::String name_; +}; + +} // namespace + +namespace internal { + +// This method expands all parameterized tests registered with macros TEST_P +// and INSTANTIATE_TEST_CASE_P into regular tests and registers those. +// This will be done just once during the program runtime. +void UnitTestImpl::RegisterParameterizedTests() { +#if GTEST_HAS_PARAM_TEST + if (!parameterized_tests_registered_) { + parameterized_test_registry_.RegisterTests(); + parameterized_tests_registered_ = true; + } +#endif +} + +} // namespace internal + +// Creates the test object, runs it, records its result, and then +// deletes it. +void TestInfo::Run() { + if (!should_run_) return; + + // Tells UnitTest where to store test result. + internal::UnitTestImpl* const impl = internal::GetUnitTestImpl(); + impl->set_current_test_info(this); + + TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater(); + + // Notifies the unit test event listeners that a test is about to start. + repeater->OnTestStart(*this); + + const TimeInMillis start = internal::GetTimeInMillis(); + + impl->os_stack_trace_getter()->UponLeavingGTest(); + + // Creates the test object. + Test* const test = internal::HandleExceptionsInMethodIfSupported( + factory_, &internal::TestFactoryBase::CreateTest, + "the test fixture's constructor"); + + // Runs the test only if the test object was created and its + // constructor didn't generate a fatal failure. + if ((test != NULL) && !Test::HasFatalFailure()) { + // This doesn't throw as all user code that can throw are wrapped into + // exception handling code. + test->Run(); + } + + // Deletes the test object. + impl->os_stack_trace_getter()->UponLeavingGTest(); + internal::HandleExceptionsInMethodIfSupported( + test, &Test::DeleteSelf_, "the test fixture's destructor"); + + result_.set_elapsed_time(internal::GetTimeInMillis() - start); + + // Notifies the unit test event listener that a test has just finished. + repeater->OnTestEnd(*this); + + // Tells UnitTest to stop associating assertion results to this + // test. + impl->set_current_test_info(NULL); +} + +// class TestCase + +// Gets the number of successful tests in this test case. +int TestCase::successful_test_count() const { + return CountIf(test_info_list_, TestPassed); +} + +// Gets the number of failed tests in this test case. +int TestCase::failed_test_count() const { + return CountIf(test_info_list_, TestFailed); +} + +int TestCase::disabled_test_count() const { + return CountIf(test_info_list_, TestDisabled); +} + +// Get the number of tests in this test case that should run. +int TestCase::test_to_run_count() const { + return CountIf(test_info_list_, ShouldRunTest); +} + +// Gets the number of all tests. +int TestCase::total_test_count() const { + return static_cast(test_info_list_.size()); +} + +// Creates a TestCase with the given name. +// +// Arguments: +// +// name: name of the test case +// a_type_param: the name of the test case's type parameter, or NULL if +// this is not a typed or a type-parameterized test case. +// set_up_tc: pointer to the function that sets up the test case +// tear_down_tc: pointer to the function that tears down the test case +TestCase::TestCase(const char* a_name, const char* a_type_param, + Test::SetUpTestCaseFunc set_up_tc, + Test::TearDownTestCaseFunc tear_down_tc) + : name_(a_name), + type_param_(a_type_param ? new std::string(a_type_param) : NULL), + set_up_tc_(set_up_tc), + tear_down_tc_(tear_down_tc), + should_run_(false), + elapsed_time_(0) { +} + +// Destructor of TestCase. +TestCase::~TestCase() { + // Deletes every Test in the collection. + ForEach(test_info_list_, internal::Delete); +} + +// Returns the i-th test among all the tests. i can range from 0 to +// total_test_count() - 1. If i is not in that range, returns NULL. +const TestInfo* TestCase::GetTestInfo(int i) const { + const int index = GetElementOr(test_indices_, i, -1); + return index < 0 ? NULL : test_info_list_[index]; +} + +// Returns the i-th test among all the tests. i can range from 0 to +// total_test_count() - 1. If i is not in that range, returns NULL. +TestInfo* TestCase::GetMutableTestInfo(int i) { + const int index = GetElementOr(test_indices_, i, -1); + return index < 0 ? NULL : test_info_list_[index]; +} + +// Adds a test to this test case. Will delete the test upon +// destruction of the TestCase object. +void TestCase::AddTestInfo(TestInfo * test_info) { + test_info_list_.push_back(test_info); + test_indices_.push_back(static_cast(test_indices_.size())); +} + +// Runs every test in this TestCase. +void TestCase::Run() { + if (!should_run_) return; + + internal::UnitTestImpl* const impl = internal::GetUnitTestImpl(); + impl->set_current_test_case(this); + + TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater(); + + repeater->OnTestCaseStart(*this); + impl->os_stack_trace_getter()->UponLeavingGTest(); + internal::HandleExceptionsInMethodIfSupported( + this, &TestCase::RunSetUpTestCase, "SetUpTestCase()"); + + const internal::TimeInMillis start = internal::GetTimeInMillis(); + for (int i = 0; i < total_test_count(); i++) { + GetMutableTestInfo(i)->Run(); + } + elapsed_time_ = internal::GetTimeInMillis() - start; + + impl->os_stack_trace_getter()->UponLeavingGTest(); + internal::HandleExceptionsInMethodIfSupported( + this, &TestCase::RunTearDownTestCase, "TearDownTestCase()"); + + repeater->OnTestCaseEnd(*this); + impl->set_current_test_case(NULL); +} + +// Clears the results of all tests in this test case. +void TestCase::ClearResult() { + ForEach(test_info_list_, TestInfo::ClearTestResult); +} + +// Shuffles the tests in this test case. +void TestCase::ShuffleTests(internal::Random* random) { + Shuffle(random, &test_indices_); +} + +// Restores the test order to before the first shuffle. +void TestCase::UnshuffleTests() { + for (size_t i = 0; i < test_indices_.size(); i++) { + test_indices_[i] = static_cast(i); + } +} + +// Formats a countable noun. Depending on its quantity, either the +// singular form or the plural form is used. e.g. +// +// FormatCountableNoun(1, "formula", "formuli") returns "1 formula". +// FormatCountableNoun(5, "book", "books") returns "5 books". +static internal::String FormatCountableNoun(int count, + const char * singular_form, + const char * plural_form) { + return internal::String::Format("%d %s", count, + count == 1 ? singular_form : plural_form); +} + +// Formats the count of tests. +static internal::String FormatTestCount(int test_count) { + return FormatCountableNoun(test_count, "test", "tests"); +} + +// Formats the count of test cases. +static internal::String FormatTestCaseCount(int test_case_count) { + return FormatCountableNoun(test_case_count, "test case", "test cases"); +} + +// Converts a TestPartResult::Type enum to human-friendly string +// representation. Both kNonFatalFailure and kFatalFailure are translated +// to "Failure", as the user usually doesn't care about the difference +// between the two when viewing the test result. +static const char * TestPartResultTypeToString(TestPartResult::Type type) { + switch (type) { + case TestPartResult::kSuccess: + return "Success"; + + case TestPartResult::kNonFatalFailure: + case TestPartResult::kFatalFailure: +#ifdef _MSC_VER + return "error: "; +#else + return "Failure\n"; +#endif + default: + return "Unknown result type"; + } +} + +// Prints a TestPartResult to a String. +static internal::String PrintTestPartResultToString( + const TestPartResult& test_part_result) { + return (Message() + << internal::FormatFileLocation(test_part_result.file_name(), + test_part_result.line_number()) + << " " << TestPartResultTypeToString(test_part_result.type()) + << test_part_result.message()).GetString(); +} + +// Prints a TestPartResult. +static void PrintTestPartResult(const TestPartResult& test_part_result) { + const internal::String& result = + PrintTestPartResultToString(test_part_result); + printf("%s\n", result.c_str()); + fflush(stdout); + // If the test program runs in Visual Studio or a debugger, the + // following statements add the test part result message to the Output + // window such that the user can double-click on it to jump to the + // corresponding source code location; otherwise they do nothing. +#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE + // We don't call OutputDebugString*() on Windows Mobile, as printing + // to stdout is done by OutputDebugString() there already - we don't + // want the same message printed twice. + ::OutputDebugStringA(result.c_str()); + ::OutputDebugStringA("\n"); +#endif +} + +// class PrettyUnitTestResultPrinter + +namespace internal { + +enum GTestColor { + COLOR_DEFAULT, + COLOR_RED, + COLOR_GREEN, + COLOR_YELLOW +}; + +#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE + +// Returns the character attribute for the given color. +WORD GetColorAttribute(GTestColor color) { + switch (color) { + case COLOR_RED: return FOREGROUND_RED; + case COLOR_GREEN: return FOREGROUND_GREEN; + case COLOR_YELLOW: return FOREGROUND_RED | FOREGROUND_GREEN; + default: return 0; + } +} + +#else + +// Returns the ANSI color code for the given color. COLOR_DEFAULT is +// an invalid input. +const char* GetAnsiColorCode(GTestColor color) { + switch (color) { + case COLOR_RED: return "1"; + case COLOR_GREEN: return "2"; + case COLOR_YELLOW: return "3"; + default: return NULL; + }; +} + +#endif // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE + +// Returns true iff Google Test should use colors in the output. +bool ShouldUseColor(bool stdout_is_tty) { + const char* const gtest_color = GTEST_FLAG(color).c_str(); + + if (String::CaseInsensitiveCStringEquals(gtest_color, "auto")) { +#if GTEST_OS_WINDOWS + // On Windows the TERM variable is usually not set, but the + // console there does support colors. + return stdout_is_tty; +#else + // On non-Windows platforms, we rely on the TERM variable. + const char* const term = posix::GetEnv("TERM"); + const bool term_supports_color = + String::CStringEquals(term, "xterm") || + String::CStringEquals(term, "xterm-color") || + String::CStringEquals(term, "xterm-256color") || + String::CStringEquals(term, "screen") || + String::CStringEquals(term, "linux") || + String::CStringEquals(term, "cygwin"); + return stdout_is_tty && term_supports_color; +#endif // GTEST_OS_WINDOWS + } + + return String::CaseInsensitiveCStringEquals(gtest_color, "yes") || + String::CaseInsensitiveCStringEquals(gtest_color, "true") || + String::CaseInsensitiveCStringEquals(gtest_color, "t") || + String::CStringEquals(gtest_color, "1"); + // We take "yes", "true", "t", and "1" as meaning "yes". If the + // value is neither one of these nor "auto", we treat it as "no" to + // be conservative. +} + +// Helpers for printing colored strings to stdout. Note that on Windows, we +// cannot simply emit special characters and have the terminal change colors. +// This routine must actually emit the characters rather than return a string +// that would be colored when printed, as can be done on Linux. +void ColoredPrintf(GTestColor color, const char* fmt, ...) { + va_list args; + va_start(args, fmt); + +#if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS + const bool use_color = false; +#else + static const bool in_color_mode = + ShouldUseColor(posix::IsATTY(posix::FileNo(stdout)) != 0); + const bool use_color = in_color_mode && (color != COLOR_DEFAULT); +#endif // GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS + // The '!= 0' comparison is necessary to satisfy MSVC 7.1. + + if (!use_color) { + vprintf(fmt, args); + va_end(args); + return; + } + +#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE + const HANDLE stdout_handle = GetStdHandle(STD_OUTPUT_HANDLE); + + // Gets the current text color. + CONSOLE_SCREEN_BUFFER_INFO buffer_info; + GetConsoleScreenBufferInfo(stdout_handle, &buffer_info); + const WORD old_color_attrs = buffer_info.wAttributes; + + // We need to flush the stream buffers into the console before each + // SetConsoleTextAttribute call lest it affect the text that is already + // printed but has not yet reached the console. + fflush(stdout); + SetConsoleTextAttribute(stdout_handle, + GetColorAttribute(color) | FOREGROUND_INTENSITY); + vprintf(fmt, args); + + fflush(stdout); + // Restores the text color. + SetConsoleTextAttribute(stdout_handle, old_color_attrs); +#else + printf("\033[0;3%sm", GetAnsiColorCode(color)); + vprintf(fmt, args); + printf("\033[m"); // Resets the terminal to default. +#endif // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE + va_end(args); +} + +void PrintFullTestCommentIfPresent(const TestInfo& test_info) { + const char* const type_param = test_info.type_param(); + const char* const value_param = test_info.value_param(); + + if (type_param != NULL || value_param != NULL) { + printf(", where "); + if (type_param != NULL) { + printf("TypeParam = %s", type_param); + if (value_param != NULL) + printf(" and "); + } + if (value_param != NULL) { + printf("GetParam() = %s", value_param); + } + } +} + +// This class implements the TestEventListener interface. +// +// Class PrettyUnitTestResultPrinter is copyable. +class PrettyUnitTestResultPrinter : public TestEventListener { + public: + PrettyUnitTestResultPrinter() {} + static void PrintTestName(const char * test_case, const char * test) { + printf("%s.%s", test_case, test); + } + + // The following methods override what's in the TestEventListener class. + virtual void OnTestProgramStart(const UnitTest& /*unit_test*/) {} + virtual void OnTestIterationStart(const UnitTest& unit_test, int iteration); + virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test); + virtual void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) {} + virtual void OnTestCaseStart(const TestCase& test_case); + virtual void OnTestStart(const TestInfo& test_info); + virtual void OnTestPartResult(const TestPartResult& result); + virtual void OnTestEnd(const TestInfo& test_info); + virtual void OnTestCaseEnd(const TestCase& test_case); + virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test); + virtual void OnEnvironmentsTearDownEnd(const UnitTest& /*unit_test*/) {} + virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration); + virtual void OnTestProgramEnd(const UnitTest& /*unit_test*/) {} + + private: + static void PrintFailedTests(const UnitTest& unit_test); + + internal::String test_case_name_; +}; + + // Fired before each iteration of tests starts. +void PrettyUnitTestResultPrinter::OnTestIterationStart( + const UnitTest& unit_test, int iteration) { + if (GTEST_FLAG(repeat) != 1) + printf("\nRepeating all tests (iteration %d) . . .\n\n", iteration + 1); + + const char* const filter = GTEST_FLAG(filter).c_str(); + + // Prints the filter if it's not *. This reminds the user that some + // tests may be skipped. + if (!internal::String::CStringEquals(filter, kUniversalFilter)) { + ColoredPrintf(COLOR_YELLOW, + "Note: %s filter = %s\n", GTEST_NAME_, filter); + } + + if (internal::ShouldShard(kTestTotalShards, kTestShardIndex, false)) { + const Int32 shard_index = Int32FromEnvOrDie(kTestShardIndex, -1); + ColoredPrintf(COLOR_YELLOW, + "Note: This is test shard %d of %s.\n", + static_cast(shard_index) + 1, + internal::posix::GetEnv(kTestTotalShards)); + } + + if (GTEST_FLAG(shuffle)) { + ColoredPrintf(COLOR_YELLOW, + "Note: Randomizing tests' orders with a seed of %d .\n", + unit_test.random_seed()); + } + + ColoredPrintf(COLOR_GREEN, "[==========] "); + printf("Running %s from %s.\n", + FormatTestCount(unit_test.test_to_run_count()).c_str(), + FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str()); + fflush(stdout); +} + +void PrettyUnitTestResultPrinter::OnEnvironmentsSetUpStart( + const UnitTest& /*unit_test*/) { + ColoredPrintf(COLOR_GREEN, "[----------] "); + printf("Global test environment set-up.\n"); + fflush(stdout); +} + +void PrettyUnitTestResultPrinter::OnTestCaseStart(const TestCase& test_case) { + test_case_name_ = test_case.name(); + const internal::String counts = + FormatCountableNoun(test_case.test_to_run_count(), "test", "tests"); + ColoredPrintf(COLOR_GREEN, "[----------] "); + printf("%s from %s", counts.c_str(), test_case_name_.c_str()); + if (test_case.type_param() == NULL) { + printf("\n"); + } else { + printf(", where TypeParam = %s\n", test_case.type_param()); + } + fflush(stdout); +} + +void PrettyUnitTestResultPrinter::OnTestStart(const TestInfo& test_info) { + ColoredPrintf(COLOR_GREEN, "[ RUN ] "); + PrintTestName(test_case_name_.c_str(), test_info.name()); + printf("\n"); + fflush(stdout); +} + +// Called after an assertion failure. +void PrettyUnitTestResultPrinter::OnTestPartResult( + const TestPartResult& result) { + // If the test part succeeded, we don't need to do anything. + if (result.type() == TestPartResult::kSuccess) + return; + + // Print failure message from the assertion (e.g. expected this and got that). + PrintTestPartResult(result); + fflush(stdout); +} + +void PrettyUnitTestResultPrinter::OnTestEnd(const TestInfo& test_info) { + if (test_info.result()->Passed()) { + ColoredPrintf(COLOR_GREEN, "[ OK ] "); + } else { + ColoredPrintf(COLOR_RED, "[ FAILED ] "); + } + PrintTestName(test_case_name_.c_str(), test_info.name()); + if (test_info.result()->Failed()) + PrintFullTestCommentIfPresent(test_info); + + if (GTEST_FLAG(print_time)) { + printf(" (%s ms)\n", internal::StreamableToString( + test_info.result()->elapsed_time()).c_str()); + } else { + printf("\n"); + } + fflush(stdout); +} + +void PrettyUnitTestResultPrinter::OnTestCaseEnd(const TestCase& test_case) { + if (!GTEST_FLAG(print_time)) return; + + test_case_name_ = test_case.name(); + const internal::String counts = + FormatCountableNoun(test_case.test_to_run_count(), "test", "tests"); + ColoredPrintf(COLOR_GREEN, "[----------] "); + printf("%s from %s (%s ms total)\n\n", + counts.c_str(), test_case_name_.c_str(), + internal::StreamableToString(test_case.elapsed_time()).c_str()); + fflush(stdout); +} + +void PrettyUnitTestResultPrinter::OnEnvironmentsTearDownStart( + const UnitTest& /*unit_test*/) { + ColoredPrintf(COLOR_GREEN, "[----------] "); + printf("Global test environment tear-down\n"); + fflush(stdout); +} + +// Internal helper for printing the list of failed tests. +void PrettyUnitTestResultPrinter::PrintFailedTests(const UnitTest& unit_test) { + const int failed_test_count = unit_test.failed_test_count(); + if (failed_test_count == 0) { + return; + } + + for (int i = 0; i < unit_test.total_test_case_count(); ++i) { + const TestCase& test_case = *unit_test.GetTestCase(i); + if (!test_case.should_run() || (test_case.failed_test_count() == 0)) { + continue; + } + for (int j = 0; j < test_case.total_test_count(); ++j) { + const TestInfo& test_info = *test_case.GetTestInfo(j); + if (!test_info.should_run() || test_info.result()->Passed()) { + continue; + } + ColoredPrintf(COLOR_RED, "[ FAILED ] "); + printf("%s.%s", test_case.name(), test_info.name()); + PrintFullTestCommentIfPresent(test_info); + printf("\n"); + } + } +} + +void PrettyUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test, + int /*iteration*/) { + ColoredPrintf(COLOR_GREEN, "[==========] "); + printf("%s from %s ran.", + FormatTestCount(unit_test.test_to_run_count()).c_str(), + FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str()); + if (GTEST_FLAG(print_time)) { + printf(" (%s ms total)", + internal::StreamableToString(unit_test.elapsed_time()).c_str()); + } + printf("\n"); + ColoredPrintf(COLOR_GREEN, "[ PASSED ] "); + printf("%s.\n", FormatTestCount(unit_test.successful_test_count()).c_str()); + + int num_failures = unit_test.failed_test_count(); + if (!unit_test.Passed()) { + const int failed_test_count = unit_test.failed_test_count(); + ColoredPrintf(COLOR_RED, "[ FAILED ] "); + printf("%s, listed below:\n", FormatTestCount(failed_test_count).c_str()); + PrintFailedTests(unit_test); + printf("\n%2d FAILED %s\n", num_failures, + num_failures == 1 ? "TEST" : "TESTS"); + } + + int num_disabled = unit_test.disabled_test_count(); + if (num_disabled && !GTEST_FLAG(also_run_disabled_tests)) { + if (!num_failures) { + printf("\n"); // Add a spacer if no FAILURE banner is displayed. + } + ColoredPrintf(COLOR_YELLOW, + " YOU HAVE %d DISABLED %s\n\n", + num_disabled, + num_disabled == 1 ? "TEST" : "TESTS"); + } + // Ensure that Google Test output is printed before, e.g., heapchecker output. + fflush(stdout); +} + +// End PrettyUnitTestResultPrinter + +// class TestEventRepeater +// +// This class forwards events to other event listeners. +class TestEventRepeater : public TestEventListener { + public: + TestEventRepeater() : forwarding_enabled_(true) {} + virtual ~TestEventRepeater(); + void Append(TestEventListener *listener); + TestEventListener* Release(TestEventListener* listener); + + // Controls whether events will be forwarded to listeners_. Set to false + // in death test child processes. + bool forwarding_enabled() const { return forwarding_enabled_; } + void set_forwarding_enabled(bool enable) { forwarding_enabled_ = enable; } + + virtual void OnTestProgramStart(const UnitTest& unit_test); + virtual void OnTestIterationStart(const UnitTest& unit_test, int iteration); + virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test); + virtual void OnEnvironmentsSetUpEnd(const UnitTest& unit_test); + virtual void OnTestCaseStart(const TestCase& test_case); + virtual void OnTestStart(const TestInfo& test_info); + virtual void OnTestPartResult(const TestPartResult& result); + virtual void OnTestEnd(const TestInfo& test_info); + virtual void OnTestCaseEnd(const TestCase& test_case); + virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test); + virtual void OnEnvironmentsTearDownEnd(const UnitTest& unit_test); + virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration); + virtual void OnTestProgramEnd(const UnitTest& unit_test); + + private: + // Controls whether events will be forwarded to listeners_. Set to false + // in death test child processes. + bool forwarding_enabled_; + // The list of listeners that receive events. + std::vector listeners_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventRepeater); +}; + +TestEventRepeater::~TestEventRepeater() { + ForEach(listeners_, Delete); +} + +void TestEventRepeater::Append(TestEventListener *listener) { + listeners_.push_back(listener); +} + +// TODO(vladl@google.com): Factor the search functionality into Vector::Find. +TestEventListener* TestEventRepeater::Release(TestEventListener *listener) { + for (size_t i = 0; i < listeners_.size(); ++i) { + if (listeners_[i] == listener) { + listeners_.erase(listeners_.begin() + i); + return listener; + } + } + + return NULL; +} + +// Since most methods are very similar, use macros to reduce boilerplate. +// This defines a member that forwards the call to all listeners. +#define GTEST_REPEATER_METHOD_(Name, Type) \ +void TestEventRepeater::Name(const Type& parameter) { \ + if (forwarding_enabled_) { \ + for (size_t i = 0; i < listeners_.size(); i++) { \ + listeners_[i]->Name(parameter); \ + } \ + } \ +} +// This defines a member that forwards the call to all listeners in reverse +// order. +#define GTEST_REVERSE_REPEATER_METHOD_(Name, Type) \ +void TestEventRepeater::Name(const Type& parameter) { \ + if (forwarding_enabled_) { \ + for (int i = static_cast(listeners_.size()) - 1; i >= 0; i--) { \ + listeners_[i]->Name(parameter); \ + } \ + } \ +} + +GTEST_REPEATER_METHOD_(OnTestProgramStart, UnitTest) +GTEST_REPEATER_METHOD_(OnEnvironmentsSetUpStart, UnitTest) +GTEST_REPEATER_METHOD_(OnTestCaseStart, TestCase) +GTEST_REPEATER_METHOD_(OnTestStart, TestInfo) +GTEST_REPEATER_METHOD_(OnTestPartResult, TestPartResult) +GTEST_REPEATER_METHOD_(OnEnvironmentsTearDownStart, UnitTest) +GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsSetUpEnd, UnitTest) +GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsTearDownEnd, UnitTest) +GTEST_REVERSE_REPEATER_METHOD_(OnTestEnd, TestInfo) +GTEST_REVERSE_REPEATER_METHOD_(OnTestCaseEnd, TestCase) +GTEST_REVERSE_REPEATER_METHOD_(OnTestProgramEnd, UnitTest) + +#undef GTEST_REPEATER_METHOD_ +#undef GTEST_REVERSE_REPEATER_METHOD_ + +void TestEventRepeater::OnTestIterationStart(const UnitTest& unit_test, + int iteration) { + if (forwarding_enabled_) { + for (size_t i = 0; i < listeners_.size(); i++) { + listeners_[i]->OnTestIterationStart(unit_test, iteration); + } + } +} + +void TestEventRepeater::OnTestIterationEnd(const UnitTest& unit_test, + int iteration) { + if (forwarding_enabled_) { + for (int i = static_cast(listeners_.size()) - 1; i >= 0; i--) { + listeners_[i]->OnTestIterationEnd(unit_test, iteration); + } + } +} + +// End TestEventRepeater + +// This class generates an XML output file. +class XmlUnitTestResultPrinter : public EmptyTestEventListener { + public: + explicit XmlUnitTestResultPrinter(const char* output_file); + + virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration); + + private: + // Is c a whitespace character that is normalized to a space character + // when it appears in an XML attribute value? + static bool IsNormalizableWhitespace(char c) { + return c == 0x9 || c == 0xA || c == 0xD; + } + + // May c appear in a well-formed XML document? + static bool IsValidXmlCharacter(char c) { + return IsNormalizableWhitespace(c) || c >= 0x20; + } + + // Returns an XML-escaped copy of the input string str. If + // is_attribute is true, the text is meant to appear as an attribute + // value, and normalizable whitespace is preserved by replacing it + // with character references. + static String EscapeXml(const char* str, bool is_attribute); + + // Returns the given string with all characters invalid in XML removed. + static string RemoveInvalidXmlCharacters(const string& str); + + // Convenience wrapper around EscapeXml when str is an attribute value. + static String EscapeXmlAttribute(const char* str) { + return EscapeXml(str, true); + } + + // Convenience wrapper around EscapeXml when str is not an attribute value. + static String EscapeXmlText(const char* str) { return EscapeXml(str, false); } + + // Streams an XML CDATA section, escaping invalid CDATA sequences as needed. + static void OutputXmlCDataSection(::std::ostream* stream, const char* data); + + // Streams an XML representation of a TestInfo object. + static void OutputXmlTestInfo(::std::ostream* stream, + const char* test_case_name, + const TestInfo& test_info); + + // Prints an XML representation of a TestCase object + static void PrintXmlTestCase(FILE* out, const TestCase& test_case); + + // Prints an XML summary of unit_test to output stream out. + static void PrintXmlUnitTest(FILE* out, const UnitTest& unit_test); + + // Produces a string representing the test properties in a result as space + // delimited XML attributes based on the property key="value" pairs. + // When the String is not empty, it includes a space at the beginning, + // to delimit this attribute from prior attributes. + static String TestPropertiesAsXmlAttributes(const TestResult& result); + + // The output file. + const String output_file_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(XmlUnitTestResultPrinter); +}; + +// Creates a new XmlUnitTestResultPrinter. +XmlUnitTestResultPrinter::XmlUnitTestResultPrinter(const char* output_file) + : output_file_(output_file) { + if (output_file_.c_str() == NULL || output_file_.empty()) { + fprintf(stderr, "XML output file may not be null\n"); + fflush(stderr); + exit(EXIT_FAILURE); + } +} + +// Called after the unit test ends. +void XmlUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test, + int /*iteration*/) { + FILE* xmlout = NULL; + FilePath output_file(output_file_); + FilePath output_dir(output_file.RemoveFileName()); + + if (output_dir.CreateDirectoriesRecursively()) { + xmlout = posix::FOpen(output_file_.c_str(), "w"); + } + if (xmlout == NULL) { + // TODO(wan): report the reason of the failure. + // + // We don't do it for now as: + // + // 1. There is no urgent need for it. + // 2. It's a bit involved to make the errno variable thread-safe on + // all three operating systems (Linux, Windows, and Mac OS). + // 3. To interpret the meaning of errno in a thread-safe way, + // we need the strerror_r() function, which is not available on + // Windows. + fprintf(stderr, + "Unable to open file \"%s\"\n", + output_file_.c_str()); + fflush(stderr); + exit(EXIT_FAILURE); + } + PrintXmlUnitTest(xmlout, unit_test); + fclose(xmlout); +} + +// Returns an XML-escaped copy of the input string str. If is_attribute +// is true, the text is meant to appear as an attribute value, and +// normalizable whitespace is preserved by replacing it with character +// references. +// +// Invalid XML characters in str, if any, are stripped from the output. +// It is expected that most, if not all, of the text processed by this +// module will consist of ordinary English text. +// If this module is ever modified to produce version 1.1 XML output, +// most invalid characters can be retained using character references. +// TODO(wan): It might be nice to have a minimally invasive, human-readable +// escaping scheme for invalid characters, rather than dropping them. +String XmlUnitTestResultPrinter::EscapeXml(const char* str, bool is_attribute) { + Message m; + + if (str != NULL) { + for (const char* src = str; *src; ++src) { + switch (*src) { + case '<': + m << "<"; + break; + case '>': + m << ">"; + break; + case '&': + m << "&"; + break; + case '\'': + if (is_attribute) + m << "'"; + else + m << '\''; + break; + case '"': + if (is_attribute) + m << """; + else + m << '"'; + break; + default: + if (IsValidXmlCharacter(*src)) { + if (is_attribute && IsNormalizableWhitespace(*src)) + m << String::Format("&#x%02X;", unsigned(*src)); + else + m << *src; + } + break; + } + } + } + + return m.GetString(); +} + +// Returns the given string with all characters invalid in XML removed. +// Currently invalid characters are dropped from the string. An +// alternative is to replace them with certain characters such as . or ?. +string XmlUnitTestResultPrinter::RemoveInvalidXmlCharacters(const string& str) { + string output; + output.reserve(str.size()); + for (string::const_iterator it = str.begin(); it != str.end(); ++it) + if (IsValidXmlCharacter(*it)) + output.push_back(*it); + + return output; +} + +// The following routines generate an XML representation of a UnitTest +// object. +// +// This is how Google Test concepts map to the DTD: +// +// <-- corresponds to a UnitTest object +// <-- corresponds to a TestCase object +// <-- corresponds to a TestInfo object +// ... +// ... +// ... +// <-- individual assertion failures +// +// +// + +// Formats the given time in milliseconds as seconds. +std::string FormatTimeInMillisAsSeconds(TimeInMillis ms) { + ::std::stringstream ss; + ss << ms/1000.0; + return ss.str(); +} + +// Streams an XML CDATA section, escaping invalid CDATA sequences as needed. +void XmlUnitTestResultPrinter::OutputXmlCDataSection(::std::ostream* stream, + const char* data) { + const char* segment = data; + *stream << ""); + if (next_segment != NULL) { + stream->write( + segment, static_cast(next_segment - segment)); + *stream << "]]>]]>"); + } else { + *stream << segment; + break; + } + } + *stream << "]]>"; +} + +// Prints an XML representation of a TestInfo object. +// TODO(wan): There is also value in printing properties with the plain printer. +void XmlUnitTestResultPrinter::OutputXmlTestInfo(::std::ostream* stream, + const char* test_case_name, + const TestInfo& test_info) { + const TestResult& result = *test_info.result(); + *stream << " \n"; + *stream << " "; + const string location = internal::FormatCompilerIndependentFileLocation( + part.file_name(), part.line_number()); + const string message = location + "\n" + part.message(); + OutputXmlCDataSection(stream, + RemoveInvalidXmlCharacters(message).c_str()); + *stream << "\n"; + } + } + + if (failures == 0) + *stream << " />\n"; + else + *stream << " \n"; +} + +// Prints an XML representation of a TestCase object +void XmlUnitTestResultPrinter::PrintXmlTestCase(FILE* out, + const TestCase& test_case) { + fprintf(out, + " \n", + FormatTimeInMillisAsSeconds(test_case.elapsed_time()).c_str()); + for (int i = 0; i < test_case.total_test_count(); ++i) { + ::std::stringstream stream; + OutputXmlTestInfo(&stream, test_case.name(), *test_case.GetTestInfo(i)); + fprintf(out, "%s", StringStreamToString(&stream).c_str()); + } + fprintf(out, " \n"); +} + +// Prints an XML summary of unit_test to output stream out. +void XmlUnitTestResultPrinter::PrintXmlUnitTest(FILE* out, + const UnitTest& unit_test) { + fprintf(out, "\n"); + fprintf(out, + "\n"); + for (int i = 0; i < unit_test.total_test_case_count(); ++i) + PrintXmlTestCase(out, *unit_test.GetTestCase(i)); + fprintf(out, "\n"); +} + +// Produces a string representing the test properties in a result as space +// delimited XML attributes based on the property key="value" pairs. +String XmlUnitTestResultPrinter::TestPropertiesAsXmlAttributes( + const TestResult& result) { + Message attributes; + for (int i = 0; i < result.test_property_count(); ++i) { + const TestProperty& property = result.GetTestProperty(i); + attributes << " " << property.key() << "=" + << "\"" << EscapeXmlAttribute(property.value()) << "\""; + } + return attributes.GetString(); +} + +// End XmlUnitTestResultPrinter + +#if GTEST_CAN_STREAM_RESULTS_ + +// Streams test results to the given port on the given host machine. +class StreamingListener : public EmptyTestEventListener { + public: + // Escapes '=', '&', '%', and '\n' characters in str as "%xx". + static string UrlEncode(const char* str); + + StreamingListener(const string& host, const string& port) + : sockfd_(-1), host_name_(host), port_num_(port) { + MakeConnection(); + Send("gtest_streaming_protocol_version=1.0\n"); + } + + virtual ~StreamingListener() { + if (sockfd_ != -1) + CloseConnection(); + } + + void OnTestProgramStart(const UnitTest& /* unit_test */) { + Send("event=TestProgramStart\n"); + } + + void OnTestProgramEnd(const UnitTest& unit_test) { + // Note that Google Test current only report elapsed time for each + // test iteration, not for the entire test program. + Send(String::Format("event=TestProgramEnd&passed=%d\n", + unit_test.Passed())); + + // Notify the streaming server to stop. + CloseConnection(); + } + + void OnTestIterationStart(const UnitTest& /* unit_test */, int iteration) { + Send(String::Format("event=TestIterationStart&iteration=%d\n", + iteration)); + } + + void OnTestIterationEnd(const UnitTest& unit_test, int /* iteration */) { + Send(String::Format("event=TestIterationEnd&passed=%d&elapsed_time=%sms\n", + unit_test.Passed(), + StreamableToString(unit_test.elapsed_time()).c_str())); + } + + void OnTestCaseStart(const TestCase& test_case) { + Send(String::Format("event=TestCaseStart&name=%s\n", test_case.name())); + } + + void OnTestCaseEnd(const TestCase& test_case) { + Send(String::Format("event=TestCaseEnd&passed=%d&elapsed_time=%sms\n", + test_case.Passed(), + StreamableToString(test_case.elapsed_time()).c_str())); + } + + void OnTestStart(const TestInfo& test_info) { + Send(String::Format("event=TestStart&name=%s\n", test_info.name())); + } + + void OnTestEnd(const TestInfo& test_info) { + Send(String::Format( + "event=TestEnd&passed=%d&elapsed_time=%sms\n", + (test_info.result())->Passed(), + StreamableToString((test_info.result())->elapsed_time()).c_str())); + } + + void OnTestPartResult(const TestPartResult& test_part_result) { + const char* file_name = test_part_result.file_name(); + if (file_name == NULL) + file_name = ""; + Send(String::Format("event=TestPartResult&file=%s&line=%d&message=", + UrlEncode(file_name).c_str(), + test_part_result.line_number())); + Send(UrlEncode(test_part_result.message()) + "\n"); + } + + private: + // Creates a client socket and connects to the server. + void MakeConnection(); + + // Closes the socket. + void CloseConnection() { + GTEST_CHECK_(sockfd_ != -1) + << "CloseConnection() can be called only when there is a connection."; + + close(sockfd_); + sockfd_ = -1; + } + + // Sends a string to the socket. + void Send(const string& message) { + GTEST_CHECK_(sockfd_ != -1) + << "Send() can be called only when there is a connection."; + + const int len = static_cast(message.length()); + if (write(sockfd_, message.c_str(), len) != len) { + GTEST_LOG_(WARNING) + << "stream_result_to: failed to stream to " + << host_name_ << ":" << port_num_; + } + } + + int sockfd_; // socket file descriptor + const string host_name_; + const string port_num_; + + GTEST_DISALLOW_COPY_AND_ASSIGN_(StreamingListener); +}; // class StreamingListener + +// Checks if str contains '=', '&', '%' or '\n' characters. If yes, +// replaces them by "%xx" where xx is their hexadecimal value. For +// example, replaces "=" with "%3D". This algorithm is O(strlen(str)) +// in both time and space -- important as the input str may contain an +// arbitrarily long test failure message and stack trace. +string StreamingListener::UrlEncode(const char* str) { + string result; + result.reserve(strlen(str) + 1); + for (char ch = *str; ch != '\0'; ch = *++str) { + switch (ch) { + case '%': + case '=': + case '&': + case '\n': + result.append(String::Format("%%%02x", static_cast(ch))); + break; + default: + result.push_back(ch); + break; + } + } + return result; +} + +void StreamingListener::MakeConnection() { + GTEST_CHECK_(sockfd_ == -1) + << "MakeConnection() can't be called when there is already a connection."; + + addrinfo hints; + memset(&hints, 0, sizeof(hints)); + hints.ai_family = AF_UNSPEC; // To allow both IPv4 and IPv6 addresses. + hints.ai_socktype = SOCK_STREAM; + addrinfo* servinfo = NULL; + + // Use the getaddrinfo() to get a linked list of IP addresses for + // the given host name. + const int error_num = getaddrinfo( + host_name_.c_str(), port_num_.c_str(), &hints, &servinfo); + if (error_num != 0) { + GTEST_LOG_(WARNING) << "stream_result_to: getaddrinfo() failed: " + << gai_strerror(error_num); + } + + // Loop through all the results and connect to the first we can. + for (addrinfo* cur_addr = servinfo; sockfd_ == -1 && cur_addr != NULL; + cur_addr = cur_addr->ai_next) { + sockfd_ = socket( + cur_addr->ai_family, cur_addr->ai_socktype, cur_addr->ai_protocol); + if (sockfd_ != -1) { + // Connect the client socket to the server socket. + if (connect(sockfd_, cur_addr->ai_addr, cur_addr->ai_addrlen) == -1) { + close(sockfd_); + sockfd_ = -1; + } + } + } + + freeaddrinfo(servinfo); // all done with this structure + + if (sockfd_ == -1) { + GTEST_LOG_(WARNING) << "stream_result_to: failed to connect to " + << host_name_ << ":" << port_num_; + } +} + +// End of class Streaming Listener +#endif // GTEST_CAN_STREAM_RESULTS__ + +// Class ScopedTrace + +// Pushes the given source file location and message onto a per-thread +// trace stack maintained by Google Test. +// L < UnitTest::mutex_ +ScopedTrace::ScopedTrace(const char* file, int line, const Message& message) { + TraceInfo trace; + trace.file = file; + trace.line = line; + trace.message = message.GetString(); + + UnitTest::GetInstance()->PushGTestTrace(trace); +} + +// Pops the info pushed by the c'tor. +// L < UnitTest::mutex_ +ScopedTrace::~ScopedTrace() { + UnitTest::GetInstance()->PopGTestTrace(); +} + + +// class OsStackTraceGetter + +// Returns the current OS stack trace as a String. Parameters: +// +// max_depth - the maximum number of stack frames to be included +// in the trace. +// skip_count - the number of top frames to be skipped; doesn't count +// against max_depth. +// +// L < mutex_ +// We use "L < mutex_" to denote that the function may acquire mutex_. +String OsStackTraceGetter::CurrentStackTrace(int, int) { + return String(""); +} + +// L < mutex_ +void OsStackTraceGetter::UponLeavingGTest() { +} + +const char* const +OsStackTraceGetter::kElidedFramesMarker = + "... " GTEST_NAME_ " internal frames ..."; + +} // namespace internal + +// class TestEventListeners + +TestEventListeners::TestEventListeners() + : repeater_(new internal::TestEventRepeater()), + default_result_printer_(NULL), + default_xml_generator_(NULL) { +} + +TestEventListeners::~TestEventListeners() { delete repeater_; } + +// Returns the standard listener responsible for the default console +// output. Can be removed from the listeners list to shut down default +// console output. Note that removing this object from the listener list +// with Release transfers its ownership to the user. +void TestEventListeners::Append(TestEventListener* listener) { + repeater_->Append(listener); +} + +// Removes the given event listener from the list and returns it. It then +// becomes the caller's responsibility to delete the listener. Returns +// NULL if the listener is not found in the list. +TestEventListener* TestEventListeners::Release(TestEventListener* listener) { + if (listener == default_result_printer_) + default_result_printer_ = NULL; + else if (listener == default_xml_generator_) + default_xml_generator_ = NULL; + return repeater_->Release(listener); +} + +// Returns repeater that broadcasts the TestEventListener events to all +// subscribers. +TestEventListener* TestEventListeners::repeater() { return repeater_; } + +// Sets the default_result_printer attribute to the provided listener. +// The listener is also added to the listener list and previous +// default_result_printer is removed from it and deleted. The listener can +// also be NULL in which case it will not be added to the list. Does +// nothing if the previous and the current listener objects are the same. +void TestEventListeners::SetDefaultResultPrinter(TestEventListener* listener) { + if (default_result_printer_ != listener) { + // It is an error to pass this method a listener that is already in the + // list. + delete Release(default_result_printer_); + default_result_printer_ = listener; + if (listener != NULL) + Append(listener); + } +} + +// Sets the default_xml_generator attribute to the provided listener. The +// listener is also added to the listener list and previous +// default_xml_generator is removed from it and deleted. The listener can +// also be NULL in which case it will not be added to the list. Does +// nothing if the previous and the current listener objects are the same. +void TestEventListeners::SetDefaultXmlGenerator(TestEventListener* listener) { + if (default_xml_generator_ != listener) { + // It is an error to pass this method a listener that is already in the + // list. + delete Release(default_xml_generator_); + default_xml_generator_ = listener; + if (listener != NULL) + Append(listener); + } +} + +// Controls whether events will be forwarded by the repeater to the +// listeners in the list. +bool TestEventListeners::EventForwardingEnabled() const { + return repeater_->forwarding_enabled(); +} + +void TestEventListeners::SuppressEventForwarding() { + repeater_->set_forwarding_enabled(false); +} + +// class UnitTest + +// Gets the singleton UnitTest object. The first time this method is +// called, a UnitTest object is constructed and returned. Consecutive +// calls will return the same object. +// +// We don't protect this under mutex_ as a user is not supposed to +// call this before main() starts, from which point on the return +// value will never change. +UnitTest * UnitTest::GetInstance() { + // When compiled with MSVC 7.1 in optimized mode, destroying the + // UnitTest object upon exiting the program messes up the exit code, + // causing successful tests to appear failed. We have to use a + // different implementation in this case to bypass the compiler bug. + // This implementation makes the compiler happy, at the cost of + // leaking the UnitTest object. + + // CodeGear C++Builder insists on a public destructor for the + // default implementation. Use this implementation to keep good OO + // design with private destructor. + +#if (_MSC_VER == 1310 && !defined(_DEBUG)) || defined(__BORLANDC__) + static UnitTest* const instance = new UnitTest; + return instance; +#else + static UnitTest instance; + return &instance; +#endif // (_MSC_VER == 1310 && !defined(_DEBUG)) || defined(__BORLANDC__) +} + +// Gets the number of successful test cases. +int UnitTest::successful_test_case_count() const { + return impl()->successful_test_case_count(); +} + +// Gets the number of failed test cases. +int UnitTest::failed_test_case_count() const { + return impl()->failed_test_case_count(); +} + +// Gets the number of all test cases. +int UnitTest::total_test_case_count() const { + return impl()->total_test_case_count(); +} + +// Gets the number of all test cases that contain at least one test +// that should run. +int UnitTest::test_case_to_run_count() const { + return impl()->test_case_to_run_count(); +} + +// Gets the number of successful tests. +int UnitTest::successful_test_count() const { + return impl()->successful_test_count(); +} + +// Gets the number of failed tests. +int UnitTest::failed_test_count() const { return impl()->failed_test_count(); } + +// Gets the number of disabled tests. +int UnitTest::disabled_test_count() const { + return impl()->disabled_test_count(); +} + +// Gets the number of all tests. +int UnitTest::total_test_count() const { return impl()->total_test_count(); } + +// Gets the number of tests that should run. +int UnitTest::test_to_run_count() const { return impl()->test_to_run_count(); } + +// Gets the elapsed time, in milliseconds. +internal::TimeInMillis UnitTest::elapsed_time() const { + return impl()->elapsed_time(); +} + +// Returns true iff the unit test passed (i.e. all test cases passed). +bool UnitTest::Passed() const { return impl()->Passed(); } + +// Returns true iff the unit test failed (i.e. some test case failed +// or something outside of all tests failed). +bool UnitTest::Failed() const { return impl()->Failed(); } + +// Gets the i-th test case among all the test cases. i can range from 0 to +// total_test_case_count() - 1. If i is not in that range, returns NULL. +const TestCase* UnitTest::GetTestCase(int i) const { + return impl()->GetTestCase(i); +} + +// Gets the i-th test case among all the test cases. i can range from 0 to +// total_test_case_count() - 1. If i is not in that range, returns NULL. +TestCase* UnitTest::GetMutableTestCase(int i) { + return impl()->GetMutableTestCase(i); +} + +// Returns the list of event listeners that can be used to track events +// inside Google Test. +TestEventListeners& UnitTest::listeners() { + return *impl()->listeners(); +} + +// Registers and returns a global test environment. When a test +// program is run, all global test environments will be set-up in the +// order they were registered. After all tests in the program have +// finished, all global test environments will be torn-down in the +// *reverse* order they were registered. +// +// The UnitTest object takes ownership of the given environment. +// +// We don't protect this under mutex_, as we only support calling it +// from the main thread. +Environment* UnitTest::AddEnvironment(Environment* env) { + if (env == NULL) { + return NULL; + } + + impl_->environments().push_back(env); + return env; +} + +// Adds a TestPartResult to the current TestResult object. All Google Test +// assertion macros (e.g. ASSERT_TRUE, EXPECT_EQ, etc) eventually call +// this to report their results. The user code should use the +// assertion macros instead of calling this directly. +// L < mutex_ +void UnitTest::AddTestPartResult(TestPartResult::Type result_type, + const char* file_name, + int line_number, + const internal::String& message, + const internal::String& os_stack_trace) { + Message msg; + msg << message; + + internal::MutexLock lock(&mutex_); + if (impl_->gtest_trace_stack().size() > 0) { + msg << "\n" << GTEST_NAME_ << " trace:"; + + for (int i = static_cast(impl_->gtest_trace_stack().size()); + i > 0; --i) { + const internal::TraceInfo& trace = impl_->gtest_trace_stack()[i - 1]; + msg << "\n" << internal::FormatFileLocation(trace.file, trace.line) + << " " << trace.message; + } + } + + if (os_stack_trace.c_str() != NULL && !os_stack_trace.empty()) { + msg << internal::kStackTraceMarker << os_stack_trace; + } + + const TestPartResult result = + TestPartResult(result_type, file_name, line_number, + msg.GetString().c_str()); + impl_->GetTestPartResultReporterForCurrentThread()-> + ReportTestPartResult(result); + + if (result_type != TestPartResult::kSuccess) { + // gtest_break_on_failure takes precedence over + // gtest_throw_on_failure. This allows a user to set the latter + // in the code (perhaps in order to use Google Test assertions + // with another testing framework) and specify the former on the + // command line for debugging. + if (GTEST_FLAG(break_on_failure)) { +#if GTEST_OS_WINDOWS + // Using DebugBreak on Windows allows gtest to still break into a debugger + // when a failure happens and both the --gtest_break_on_failure and + // the --gtest_catch_exceptions flags are specified. + DebugBreak(); +#else + // Dereference NULL through a volatile pointer to prevent the compiler + // from removing. We use this rather than abort() or __builtin_trap() for + // portability: Symbian doesn't implement abort() well, and some debuggers + // don't correctly trap abort(). + *static_cast(NULL) = 1; +#endif // GTEST_OS_WINDOWS + } else if (GTEST_FLAG(throw_on_failure)) { +#if GTEST_HAS_EXCEPTIONS + throw GoogleTestFailureException(result); +#else + // We cannot call abort() as it generates a pop-up in debug mode + // that cannot be suppressed in VC 7.1 or below. + exit(1); +#endif + } + } +} + +// Creates and adds a property to the current TestResult. If a property matching +// the supplied value already exists, updates its value instead. +void UnitTest::RecordPropertyForCurrentTest(const char* key, + const char* value) { + const TestProperty test_property(key, value); + impl_->current_test_result()->RecordProperty(test_property); +} + +// Runs all tests in this UnitTest object and prints the result. +// Returns 0 if successful, or 1 otherwise. +// +// We don't protect this under mutex_, as we only support calling it +// from the main thread. +int UnitTest::Run() { + // Captures the value of GTEST_FLAG(catch_exceptions). This value will be + // used for the duration of the program. + impl()->set_catch_exceptions(GTEST_FLAG(catch_exceptions)); + +#if GTEST_HAS_SEH + const bool in_death_test_child_process = + internal::GTEST_FLAG(internal_run_death_test).length() > 0; + + // Either the user wants Google Test to catch exceptions thrown by the + // tests or this is executing in the context of death test child + // process. In either case the user does not want to see pop-up dialogs + // about crashes - they are expected. + if (impl()->catch_exceptions() || in_death_test_child_process) { + +# if !GTEST_OS_WINDOWS_MOBILE + // SetErrorMode doesn't exist on CE. + SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOALIGNMENTFAULTEXCEPT | + SEM_NOGPFAULTERRORBOX | SEM_NOOPENFILEERRORBOX); +# endif // !GTEST_OS_WINDOWS_MOBILE + +# if (defined(_MSC_VER) || GTEST_OS_WINDOWS_MINGW) && !GTEST_OS_WINDOWS_MOBILE + // Death test children can be terminated with _abort(). On Windows, + // _abort() can show a dialog with a warning message. This forces the + // abort message to go to stderr instead. + _set_error_mode(_OUT_TO_STDERR); +# endif + +# if _MSC_VER >= 1400 && !GTEST_OS_WINDOWS_MOBILE + // In the debug version, Visual Studio pops up a separate dialog + // offering a choice to debug the aborted program. We need to suppress + // this dialog or it will pop up for every EXPECT/ASSERT_DEATH statement + // executed. Google Test will notify the user of any unexpected + // failure via stderr. + // + // VC++ doesn't define _set_abort_behavior() prior to the version 8.0. + // Users of prior VC versions shall suffer the agony and pain of + // clicking through the countless debug dialogs. + // TODO(vladl@google.com): find a way to suppress the abort dialog() in the + // debug mode when compiled with VC 7.1 or lower. + if (!GTEST_FLAG(break_on_failure)) + _set_abort_behavior( + 0x0, // Clear the following flags: + _WRITE_ABORT_MSG | _CALL_REPORTFAULT); // pop-up window, core dump. +# endif + + } +#endif // GTEST_HAS_SEH + + return internal::HandleExceptionsInMethodIfSupported( + impl(), + &internal::UnitTestImpl::RunAllTests, + "auxiliary test code (environments or event listeners)") ? 0 : 1; +} + +// Returns the working directory when the first TEST() or TEST_F() was +// executed. +const char* UnitTest::original_working_dir() const { + return impl_->original_working_dir_.c_str(); +} + +// Returns the TestCase object for the test that's currently running, +// or NULL if no test is running. +// L < mutex_ +const TestCase* UnitTest::current_test_case() const { + internal::MutexLock lock(&mutex_); + return impl_->current_test_case(); +} + +// Returns the TestInfo object for the test that's currently running, +// or NULL if no test is running. +// L < mutex_ +const TestInfo* UnitTest::current_test_info() const { + internal::MutexLock lock(&mutex_); + return impl_->current_test_info(); +} + +// Returns the random seed used at the start of the current test run. +int UnitTest::random_seed() const { return impl_->random_seed(); } + +#if GTEST_HAS_PARAM_TEST +// Returns ParameterizedTestCaseRegistry object used to keep track of +// value-parameterized tests and instantiate and register them. +// L < mutex_ +internal::ParameterizedTestCaseRegistry& + UnitTest::parameterized_test_registry() { + return impl_->parameterized_test_registry(); +} +#endif // GTEST_HAS_PARAM_TEST + +// Creates an empty UnitTest. +UnitTest::UnitTest() { + impl_ = new internal::UnitTestImpl(this); +} + +// Destructor of UnitTest. +UnitTest::~UnitTest() { + delete impl_; +} + +// Pushes a trace defined by SCOPED_TRACE() on to the per-thread +// Google Test trace stack. +// L < mutex_ +void UnitTest::PushGTestTrace(const internal::TraceInfo& trace) { + internal::MutexLock lock(&mutex_); + impl_->gtest_trace_stack().push_back(trace); +} + +// Pops a trace from the per-thread Google Test trace stack. +// L < mutex_ +void UnitTest::PopGTestTrace() { + internal::MutexLock lock(&mutex_); + impl_->gtest_trace_stack().pop_back(); +} + +namespace internal { + +UnitTestImpl::UnitTestImpl(UnitTest* parent) + : parent_(parent), +#ifdef _MSC_VER +# pragma warning(push) // Saves the current warning state. +# pragma warning(disable:4355) // Temporarily disables warning 4355 + // (using this in initializer). + default_global_test_part_result_reporter_(this), + default_per_thread_test_part_result_reporter_(this), +# pragma warning(pop) // Restores the warning state again. +#else + default_global_test_part_result_reporter_(this), + default_per_thread_test_part_result_reporter_(this), +#endif // _MSC_VER + global_test_part_result_repoter_( + &default_global_test_part_result_reporter_), + per_thread_test_part_result_reporter_( + &default_per_thread_test_part_result_reporter_), +#if GTEST_HAS_PARAM_TEST + parameterized_test_registry_(), + parameterized_tests_registered_(false), +#endif // GTEST_HAS_PARAM_TEST + last_death_test_case_(-1), + current_test_case_(NULL), + current_test_info_(NULL), + ad_hoc_test_result_(), + os_stack_trace_getter_(NULL), + post_flag_parse_init_performed_(false), + random_seed_(0), // Will be overridden by the flag before first use. + random_(0), // Will be reseeded before first use. + elapsed_time_(0), +#if GTEST_HAS_DEATH_TEST + internal_run_death_test_flag_(NULL), + death_test_factory_(new DefaultDeathTestFactory), +#endif + // Will be overridden by the flag before first use. + catch_exceptions_(false) { + listeners()->SetDefaultResultPrinter(new PrettyUnitTestResultPrinter); +} + +UnitTestImpl::~UnitTestImpl() { + // Deletes every TestCase. + ForEach(test_cases_, internal::Delete); + + // Deletes every Environment. + ForEach(environments_, internal::Delete); + + delete os_stack_trace_getter_; +} + +#if GTEST_HAS_DEATH_TEST +// Disables event forwarding if the control is currently in a death test +// subprocess. Must not be called before InitGoogleTest. +void UnitTestImpl::SuppressTestEventsIfInSubprocess() { + if (internal_run_death_test_flag_.get() != NULL) + listeners()->SuppressEventForwarding(); +} +#endif // GTEST_HAS_DEATH_TEST + +// Initializes event listeners performing XML output as specified by +// UnitTestOptions. Must not be called before InitGoogleTest. +void UnitTestImpl::ConfigureXmlOutput() { + const String& output_format = UnitTestOptions::GetOutputFormat(); + if (output_format == "xml") { + listeners()->SetDefaultXmlGenerator(new XmlUnitTestResultPrinter( + UnitTestOptions::GetAbsolutePathToOutputFile().c_str())); + } else if (output_format != "") { + printf("WARNING: unrecognized output format \"%s\" ignored.\n", + output_format.c_str()); + fflush(stdout); + } +} + +#if GTEST_CAN_STREAM_RESULTS_ +// Initializes event listeners for streaming test results in String form. +// Must not be called before InitGoogleTest. +void UnitTestImpl::ConfigureStreamingOutput() { + const string& target = GTEST_FLAG(stream_result_to); + if (!target.empty()) { + const size_t pos = target.find(':'); + if (pos != string::npos) { + listeners()->Append(new StreamingListener(target.substr(0, pos), + target.substr(pos+1))); + } else { + printf("WARNING: unrecognized streaming target \"%s\" ignored.\n", + target.c_str()); + fflush(stdout); + } + } +} +#endif // GTEST_CAN_STREAM_RESULTS_ + +// Performs initialization dependent upon flag values obtained in +// ParseGoogleTestFlagsOnly. Is called from InitGoogleTest after the call to +// ParseGoogleTestFlagsOnly. In case a user neglects to call InitGoogleTest +// this function is also called from RunAllTests. Since this function can be +// called more than once, it has to be idempotent. +void UnitTestImpl::PostFlagParsingInit() { + // Ensures that this function does not execute more than once. + if (!post_flag_parse_init_performed_) { + post_flag_parse_init_performed_ = true; + +#if GTEST_HAS_DEATH_TEST + InitDeathTestSubprocessControlInfo(); + SuppressTestEventsIfInSubprocess(); +#endif // GTEST_HAS_DEATH_TEST + + // Registers parameterized tests. This makes parameterized tests + // available to the UnitTest reflection API without running + // RUN_ALL_TESTS. + RegisterParameterizedTests(); + + // Configures listeners for XML output. This makes it possible for users + // to shut down the default XML output before invoking RUN_ALL_TESTS. + ConfigureXmlOutput(); + +#if GTEST_CAN_STREAM_RESULTS_ + // Configures listeners for streaming test results to the specified server. + ConfigureStreamingOutput(); +#endif // GTEST_CAN_STREAM_RESULTS_ + } +} + +// A predicate that checks the name of a TestCase against a known +// value. +// +// This is used for implementation of the UnitTest class only. We put +// it in the anonymous namespace to prevent polluting the outer +// namespace. +// +// TestCaseNameIs is copyable. +class TestCaseNameIs { + public: + // Constructor. + explicit TestCaseNameIs(const String& name) + : name_(name) {} + + // Returns true iff the name of test_case matches name_. + bool operator()(const TestCase* test_case) const { + return test_case != NULL && strcmp(test_case->name(), name_.c_str()) == 0; + } + + private: + String name_; +}; + +// Finds and returns a TestCase with the given name. If one doesn't +// exist, creates one and returns it. It's the CALLER'S +// RESPONSIBILITY to ensure that this function is only called WHEN THE +// TESTS ARE NOT SHUFFLED. +// +// Arguments: +// +// test_case_name: name of the test case +// type_param: the name of the test case's type parameter, or NULL if +// this is not a typed or a type-parameterized test case. +// set_up_tc: pointer to the function that sets up the test case +// tear_down_tc: pointer to the function that tears down the test case +TestCase* UnitTestImpl::GetTestCase(const char* test_case_name, + const char* type_param, + Test::SetUpTestCaseFunc set_up_tc, + Test::TearDownTestCaseFunc tear_down_tc) { + // Can we find a TestCase with the given name? + const std::vector::const_iterator test_case = + std::find_if(test_cases_.begin(), test_cases_.end(), + TestCaseNameIs(test_case_name)); + + if (test_case != test_cases_.end()) + return *test_case; + + // No. Let's create one. + TestCase* const new_test_case = + new TestCase(test_case_name, type_param, set_up_tc, tear_down_tc); + + // Is this a death test case? + if (internal::UnitTestOptions::MatchesFilter(String(test_case_name), + kDeathTestCaseFilter)) { + // Yes. Inserts the test case after the last death test case + // defined so far. This only works when the test cases haven't + // been shuffled. Otherwise we may end up running a death test + // after a non-death test. + ++last_death_test_case_; + test_cases_.insert(test_cases_.begin() + last_death_test_case_, + new_test_case); + } else { + // No. Appends to the end of the list. + test_cases_.push_back(new_test_case); + } + + test_case_indices_.push_back(static_cast(test_case_indices_.size())); + return new_test_case; +} + +// Helpers for setting up / tearing down the given environment. They +// are for use in the ForEach() function. +static void SetUpEnvironment(Environment* env) { env->SetUp(); } +static void TearDownEnvironment(Environment* env) { env->TearDown(); } + +// Runs all tests in this UnitTest object, prints the result, and +// returns true if all tests are successful. If any exception is +// thrown during a test, the test is considered to be failed, but the +// rest of the tests will still be run. +// +// When parameterized tests are enabled, it expands and registers +// parameterized tests first in RegisterParameterizedTests(). +// All other functions called from RunAllTests() may safely assume that +// parameterized tests are ready to be counted and run. +bool UnitTestImpl::RunAllTests() { + // Makes sure InitGoogleTest() was called. + if (!GTestIsInitialized()) { + printf("%s", + "\nThis test program did NOT call ::testing::InitGoogleTest " + "before calling RUN_ALL_TESTS(). Please fix it.\n"); + return false; + } + + // Do not run any test if the --help flag was specified. + if (g_help_flag) + return true; + + // Repeats the call to the post-flag parsing initialization in case the + // user didn't call InitGoogleTest. + PostFlagParsingInit(); + + // Even if sharding is not on, test runners may want to use the + // GTEST_SHARD_STATUS_FILE to query whether the test supports the sharding + // protocol. + internal::WriteToShardStatusFileIfNeeded(); + + // True iff we are in a subprocess for running a thread-safe-style + // death test. + bool in_subprocess_for_death_test = false; + +#if GTEST_HAS_DEATH_TEST + in_subprocess_for_death_test = (internal_run_death_test_flag_.get() != NULL); +#endif // GTEST_HAS_DEATH_TEST + + const bool should_shard = ShouldShard(kTestTotalShards, kTestShardIndex, + in_subprocess_for_death_test); + + // Compares the full test names with the filter to decide which + // tests to run. + const bool has_tests_to_run = FilterTests(should_shard + ? HONOR_SHARDING_PROTOCOL + : IGNORE_SHARDING_PROTOCOL) > 0; + + // Lists the tests and exits if the --gtest_list_tests flag was specified. + if (GTEST_FLAG(list_tests)) { + // This must be called *after* FilterTests() has been called. + ListTestsMatchingFilter(); + return true; + } + + random_seed_ = GTEST_FLAG(shuffle) ? + GetRandomSeedFromFlag(GTEST_FLAG(random_seed)) : 0; + + // True iff at least one test has failed. + bool failed = false; + + TestEventListener* repeater = listeners()->repeater(); + + repeater->OnTestProgramStart(*parent_); + + // How many times to repeat the tests? We don't want to repeat them + // when we are inside the subprocess of a death test. + const int repeat = in_subprocess_for_death_test ? 1 : GTEST_FLAG(repeat); + // Repeats forever if the repeat count is negative. + const bool forever = repeat < 0; + for (int i = 0; forever || i != repeat; i++) { + // We want to preserve failures generated by ad-hoc test + // assertions executed before RUN_ALL_TESTS(). + ClearNonAdHocTestResult(); + + const TimeInMillis start = GetTimeInMillis(); + + // Shuffles test cases and tests if requested. + if (has_tests_to_run && GTEST_FLAG(shuffle)) { + random()->Reseed(random_seed_); + // This should be done before calling OnTestIterationStart(), + // such that a test event listener can see the actual test order + // in the event. + ShuffleTests(); + } + + // Tells the unit test event listeners that the tests are about to start. + repeater->OnTestIterationStart(*parent_, i); + + // Runs each test case if there is at least one test to run. + if (has_tests_to_run) { + // Sets up all environments beforehand. + repeater->OnEnvironmentsSetUpStart(*parent_); + ForEach(environments_, SetUpEnvironment); + repeater->OnEnvironmentsSetUpEnd(*parent_); + + // Runs the tests only if there was no fatal failure during global + // set-up. + if (!Test::HasFatalFailure()) { + for (int test_index = 0; test_index < total_test_case_count(); + test_index++) { + GetMutableTestCase(test_index)->Run(); + } + } + + // Tears down all environments in reverse order afterwards. + repeater->OnEnvironmentsTearDownStart(*parent_); + std::for_each(environments_.rbegin(), environments_.rend(), + TearDownEnvironment); + repeater->OnEnvironmentsTearDownEnd(*parent_); + } + + elapsed_time_ = GetTimeInMillis() - start; + + // Tells the unit test event listener that the tests have just finished. + repeater->OnTestIterationEnd(*parent_, i); + + // Gets the result and clears it. + if (!Passed()) { + failed = true; + } + + // Restores the original test order after the iteration. This + // allows the user to quickly repro a failure that happens in the + // N-th iteration without repeating the first (N - 1) iterations. + // This is not enclosed in "if (GTEST_FLAG(shuffle)) { ... }", in + // case the user somehow changes the value of the flag somewhere + // (it's always safe to unshuffle the tests). + UnshuffleTests(); + + if (GTEST_FLAG(shuffle)) { + // Picks a new random seed for each iteration. + random_seed_ = GetNextRandomSeed(random_seed_); + } + } + + repeater->OnTestProgramEnd(*parent_); + + return !failed; +} + +// Reads the GTEST_SHARD_STATUS_FILE environment variable, and creates the file +// if the variable is present. If a file already exists at this location, this +// function will write over it. If the variable is present, but the file cannot +// be created, prints an error and exits. +void WriteToShardStatusFileIfNeeded() { + const char* const test_shard_file = posix::GetEnv(kTestShardStatusFile); + if (test_shard_file != NULL) { + FILE* const file = posix::FOpen(test_shard_file, "w"); + if (file == NULL) { + ColoredPrintf(COLOR_RED, + "Could not write to the test shard status file \"%s\" " + "specified by the %s environment variable.\n", + test_shard_file, kTestShardStatusFile); + fflush(stdout); + exit(EXIT_FAILURE); + } + fclose(file); + } +} + +// Checks whether sharding is enabled by examining the relevant +// environment variable values. If the variables are present, +// but inconsistent (i.e., shard_index >= total_shards), prints +// an error and exits. If in_subprocess_for_death_test, sharding is +// disabled because it must only be applied to the original test +// process. Otherwise, we could filter out death tests we intended to execute. +bool ShouldShard(const char* total_shards_env, + const char* shard_index_env, + bool in_subprocess_for_death_test) { + if (in_subprocess_for_death_test) { + return false; + } + + const Int32 total_shards = Int32FromEnvOrDie(total_shards_env, -1); + const Int32 shard_index = Int32FromEnvOrDie(shard_index_env, -1); + + if (total_shards == -1 && shard_index == -1) { + return false; + } else if (total_shards == -1 && shard_index != -1) { + const Message msg = Message() + << "Invalid environment variables: you have " + << kTestShardIndex << " = " << shard_index + << ", but have left " << kTestTotalShards << " unset.\n"; + ColoredPrintf(COLOR_RED, msg.GetString().c_str()); + fflush(stdout); + exit(EXIT_FAILURE); + } else if (total_shards != -1 && shard_index == -1) { + const Message msg = Message() + << "Invalid environment variables: you have " + << kTestTotalShards << " = " << total_shards + << ", but have left " << kTestShardIndex << " unset.\n"; + ColoredPrintf(COLOR_RED, msg.GetString().c_str()); + fflush(stdout); + exit(EXIT_FAILURE); + } else if (shard_index < 0 || shard_index >= total_shards) { + const Message msg = Message() + << "Invalid environment variables: we require 0 <= " + << kTestShardIndex << " < " << kTestTotalShards + << ", but you have " << kTestShardIndex << "=" << shard_index + << ", " << kTestTotalShards << "=" << total_shards << ".\n"; + ColoredPrintf(COLOR_RED, msg.GetString().c_str()); + fflush(stdout); + exit(EXIT_FAILURE); + } + + return total_shards > 1; +} + +// Parses the environment variable var as an Int32. If it is unset, +// returns default_val. If it is not an Int32, prints an error +// and aborts. +Int32 Int32FromEnvOrDie(const char* var, Int32 default_val) { + const char* str_val = posix::GetEnv(var); + if (str_val == NULL) { + return default_val; + } + + Int32 result; + if (!ParseInt32(Message() << "The value of environment variable " << var, + str_val, &result)) { + exit(EXIT_FAILURE); + } + return result; +} + +// Given the total number of shards, the shard index, and the test id, +// returns true iff the test should be run on this shard. The test id is +// some arbitrary but unique non-negative integer assigned to each test +// method. Assumes that 0 <= shard_index < total_shards. +bool ShouldRunTestOnShard(int total_shards, int shard_index, int test_id) { + return (test_id % total_shards) == shard_index; +} + +// Compares the name of each test with the user-specified filter to +// decide whether the test should be run, then records the result in +// each TestCase and TestInfo object. +// If shard_tests == true, further filters tests based on sharding +// variables in the environment - see +// http://code.google.com/p/googletest/wiki/GoogleTestAdvancedGuide. +// Returns the number of tests that should run. +int UnitTestImpl::FilterTests(ReactionToSharding shard_tests) { + const Int32 total_shards = shard_tests == HONOR_SHARDING_PROTOCOL ? + Int32FromEnvOrDie(kTestTotalShards, -1) : -1; + const Int32 shard_index = shard_tests == HONOR_SHARDING_PROTOCOL ? + Int32FromEnvOrDie(kTestShardIndex, -1) : -1; + + // num_runnable_tests are the number of tests that will + // run across all shards (i.e., match filter and are not disabled). + // num_selected_tests are the number of tests to be run on + // this shard. + int num_runnable_tests = 0; + int num_selected_tests = 0; + for (size_t i = 0; i < test_cases_.size(); i++) { + TestCase* const test_case = test_cases_[i]; + const String &test_case_name = test_case->name(); + test_case->set_should_run(false); + + for (size_t j = 0; j < test_case->test_info_list().size(); j++) { + TestInfo* const test_info = test_case->test_info_list()[j]; + const String test_name(test_info->name()); + // A test is disabled if test case name or test name matches + // kDisableTestFilter. + const bool is_disabled = + internal::UnitTestOptions::MatchesFilter(test_case_name, + kDisableTestFilter) || + internal::UnitTestOptions::MatchesFilter(test_name, + kDisableTestFilter); + test_info->is_disabled_ = is_disabled; + + const bool matches_filter = + internal::UnitTestOptions::FilterMatchesTest(test_case_name, + test_name); + test_info->matches_filter_ = matches_filter; + + const bool is_runnable = + (GTEST_FLAG(also_run_disabled_tests) || !is_disabled) && + matches_filter; + + const bool is_selected = is_runnable && + (shard_tests == IGNORE_SHARDING_PROTOCOL || + ShouldRunTestOnShard(total_shards, shard_index, + num_runnable_tests)); + + num_runnable_tests += is_runnable; + num_selected_tests += is_selected; + + test_info->should_run_ = is_selected; + test_case->set_should_run(test_case->should_run() || is_selected); + } + } + return num_selected_tests; +} + +// Prints the names of the tests matching the user-specified filter flag. +void UnitTestImpl::ListTestsMatchingFilter() { + for (size_t i = 0; i < test_cases_.size(); i++) { + const TestCase* const test_case = test_cases_[i]; + bool printed_test_case_name = false; + + for (size_t j = 0; j < test_case->test_info_list().size(); j++) { + const TestInfo* const test_info = + test_case->test_info_list()[j]; + if (test_info->matches_filter_) { + if (!printed_test_case_name) { + printed_test_case_name = true; + printf("%s.\n", test_case->name()); + } + printf(" %s\n", test_info->name()); + } + } + } + fflush(stdout); +} + +// Sets the OS stack trace getter. +// +// Does nothing if the input and the current OS stack trace getter are +// the same; otherwise, deletes the old getter and makes the input the +// current getter. +void UnitTestImpl::set_os_stack_trace_getter( + OsStackTraceGetterInterface* getter) { + if (os_stack_trace_getter_ != getter) { + delete os_stack_trace_getter_; + os_stack_trace_getter_ = getter; + } +} + +// Returns the current OS stack trace getter if it is not NULL; +// otherwise, creates an OsStackTraceGetter, makes it the current +// getter, and returns it. +OsStackTraceGetterInterface* UnitTestImpl::os_stack_trace_getter() { + if (os_stack_trace_getter_ == NULL) { + os_stack_trace_getter_ = new OsStackTraceGetter; + } + + return os_stack_trace_getter_; +} + +// Returns the TestResult for the test that's currently running, or +// the TestResult for the ad hoc test if no test is running. +TestResult* UnitTestImpl::current_test_result() { + return current_test_info_ ? + &(current_test_info_->result_) : &ad_hoc_test_result_; +} + +// Shuffles all test cases, and the tests within each test case, +// making sure that death tests are still run first. +void UnitTestImpl::ShuffleTests() { + // Shuffles the death test cases. + ShuffleRange(random(), 0, last_death_test_case_ + 1, &test_case_indices_); + + // Shuffles the non-death test cases. + ShuffleRange(random(), last_death_test_case_ + 1, + static_cast(test_cases_.size()), &test_case_indices_); + + // Shuffles the tests inside each test case. + for (size_t i = 0; i < test_cases_.size(); i++) { + test_cases_[i]->ShuffleTests(random()); + } +} + +// Restores the test cases and tests to their order before the first shuffle. +void UnitTestImpl::UnshuffleTests() { + for (size_t i = 0; i < test_cases_.size(); i++) { + // Unshuffles the tests in each test case. + test_cases_[i]->UnshuffleTests(); + // Resets the index of each test case. + test_case_indices_[i] = static_cast(i); + } +} + +// Returns the current OS stack trace as a String. +// +// The maximum number of stack frames to be included is specified by +// the gtest_stack_trace_depth flag. The skip_count parameter +// specifies the number of top frames to be skipped, which doesn't +// count against the number of frames to be included. +// +// For example, if Foo() calls Bar(), which in turn calls +// GetCurrentOsStackTraceExceptTop(..., 1), Foo() will be included in +// the trace but Bar() and GetCurrentOsStackTraceExceptTop() won't. +String GetCurrentOsStackTraceExceptTop(UnitTest* /*unit_test*/, + int skip_count) { + // We pass skip_count + 1 to skip this wrapper function in addition + // to what the user really wants to skip. + return GetUnitTestImpl()->CurrentOsStackTraceExceptTop(skip_count + 1); +} + +// Used by the GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_ macro to +// suppress unreachable code warnings. +namespace { +class ClassUniqueToAlwaysTrue {}; +} + +bool IsTrue(bool condition) { return condition; } + +bool AlwaysTrue() { +#if GTEST_HAS_EXCEPTIONS + // This condition is always false so AlwaysTrue() never actually throws, + // but it makes the compiler think that it may throw. + if (IsTrue(false)) + throw ClassUniqueToAlwaysTrue(); +#endif // GTEST_HAS_EXCEPTIONS + return true; +} + +// If *pstr starts with the given prefix, modifies *pstr to be right +// past the prefix and returns true; otherwise leaves *pstr unchanged +// and returns false. None of pstr, *pstr, and prefix can be NULL. +bool SkipPrefix(const char* prefix, const char** pstr) { + const size_t prefix_len = strlen(prefix); + if (strncmp(*pstr, prefix, prefix_len) == 0) { + *pstr += prefix_len; + return true; + } + return false; +} + +// Parses a string as a command line flag. The string should have +// the format "--flag=value". When def_optional is true, the "=value" +// part can be omitted. +// +// Returns the value of the flag, or NULL if the parsing failed. +const char* ParseFlagValue(const char* str, + const char* flag, + bool def_optional) { + // str and flag must not be NULL. + if (str == NULL || flag == NULL) return NULL; + + // The flag must start with "--" followed by GTEST_FLAG_PREFIX_. + const String flag_str = String::Format("--%s%s", GTEST_FLAG_PREFIX_, flag); + const size_t flag_len = flag_str.length(); + if (strncmp(str, flag_str.c_str(), flag_len) != 0) return NULL; + + // Skips the flag name. + const char* flag_end = str + flag_len; + + // When def_optional is true, it's OK to not have a "=value" part. + if (def_optional && (flag_end[0] == '\0')) { + return flag_end; + } + + // If def_optional is true and there are more characters after the + // flag name, or if def_optional is false, there must be a '=' after + // the flag name. + if (flag_end[0] != '=') return NULL; + + // Returns the string after "=". + return flag_end + 1; +} + +// Parses a string for a bool flag, in the form of either +// "--flag=value" or "--flag". +// +// In the former case, the value is taken as true as long as it does +// not start with '0', 'f', or 'F'. +// +// In the latter case, the value is taken as true. +// +// On success, stores the value of the flag in *value, and returns +// true. On failure, returns false without changing *value. +bool ParseBoolFlag(const char* str, const char* flag, bool* value) { + // Gets the value of the flag as a string. + const char* const value_str = ParseFlagValue(str, flag, true); + + // Aborts if the parsing failed. + if (value_str == NULL) return false; + + // Converts the string value to a bool. + *value = !(*value_str == '0' || *value_str == 'f' || *value_str == 'F'); + return true; +} + +// Parses a string for an Int32 flag, in the form of +// "--flag=value". +// +// On success, stores the value of the flag in *value, and returns +// true. On failure, returns false without changing *value. +bool ParseInt32Flag(const char* str, const char* flag, Int32* value) { + // Gets the value of the flag as a string. + const char* const value_str = ParseFlagValue(str, flag, false); + + // Aborts if the parsing failed. + if (value_str == NULL) return false; + + // Sets *value to the value of the flag. + return ParseInt32(Message() << "The value of flag --" << flag, + value_str, value); +} + +// Parses a string for a string flag, in the form of +// "--flag=value". +// +// On success, stores the value of the flag in *value, and returns +// true. On failure, returns false without changing *value. +bool ParseStringFlag(const char* str, const char* flag, String* value) { + // Gets the value of the flag as a string. + const char* const value_str = ParseFlagValue(str, flag, false); + + // Aborts if the parsing failed. + if (value_str == NULL) return false; + + // Sets *value to the value of the flag. + *value = value_str; + return true; +} + +// Determines whether a string has a prefix that Google Test uses for its +// flags, i.e., starts with GTEST_FLAG_PREFIX_ or GTEST_FLAG_PREFIX_DASH_. +// If Google Test detects that a command line flag has its prefix but is not +// recognized, it will print its help message. Flags starting with +// GTEST_INTERNAL_PREFIX_ followed by "internal_" are considered Google Test +// internal flags and do not trigger the help message. +static bool HasGoogleTestFlagPrefix(const char* str) { + return (SkipPrefix("--", &str) || + SkipPrefix("-", &str) || + SkipPrefix("/", &str)) && + !SkipPrefix(GTEST_FLAG_PREFIX_ "internal_", &str) && + (SkipPrefix(GTEST_FLAG_PREFIX_, &str) || + SkipPrefix(GTEST_FLAG_PREFIX_DASH_, &str)); +} + +// Prints a string containing code-encoded text. The following escape +// sequences can be used in the string to control the text color: +// +// @@ prints a single '@' character. +// @R changes the color to red. +// @G changes the color to green. +// @Y changes the color to yellow. +// @D changes to the default terminal text color. +// +// TODO(wan@google.com): Write tests for this once we add stdout +// capturing to Google Test. +static void PrintColorEncoded(const char* str) { + GTestColor color = COLOR_DEFAULT; // The current color. + + // Conceptually, we split the string into segments divided by escape + // sequences. Then we print one segment at a time. At the end of + // each iteration, the str pointer advances to the beginning of the + // next segment. + for (;;) { + const char* p = strchr(str, '@'); + if (p == NULL) { + ColoredPrintf(color, "%s", str); + return; + } + + ColoredPrintf(color, "%s", String(str, p - str).c_str()); + + const char ch = p[1]; + str = p + 2; + if (ch == '@') { + ColoredPrintf(color, "@"); + } else if (ch == 'D') { + color = COLOR_DEFAULT; + } else if (ch == 'R') { + color = COLOR_RED; + } else if (ch == 'G') { + color = COLOR_GREEN; + } else if (ch == 'Y') { + color = COLOR_YELLOW; + } else { + --str; + } + } +} + +static const char kColorEncodedHelpMessage[] = +"This program contains tests written using " GTEST_NAME_ ". You can use the\n" +"following command line flags to control its behavior:\n" +"\n" +"Test Selection:\n" +" @G--" GTEST_FLAG_PREFIX_ "list_tests@D\n" +" List the names of all tests instead of running them. The name of\n" +" TEST(Foo, Bar) is \"Foo.Bar\".\n" +" @G--" GTEST_FLAG_PREFIX_ "filter=@YPOSTIVE_PATTERNS" + "[@G-@YNEGATIVE_PATTERNS]@D\n" +" Run only the tests whose name matches one of the positive patterns but\n" +" none of the negative patterns. '?' matches any single character; '*'\n" +" matches any substring; ':' separates two patterns.\n" +" @G--" GTEST_FLAG_PREFIX_ "also_run_disabled_tests@D\n" +" Run all disabled tests too.\n" +"\n" +"Test Execution:\n" +" @G--" GTEST_FLAG_PREFIX_ "repeat=@Y[COUNT]@D\n" +" Run the tests repeatedly; use a negative count to repeat forever.\n" +" @G--" GTEST_FLAG_PREFIX_ "shuffle@D\n" +" Randomize tests' orders on every iteration.\n" +" @G--" GTEST_FLAG_PREFIX_ "random_seed=@Y[NUMBER]@D\n" +" Random number seed to use for shuffling test orders (between 1 and\n" +" 99999, or 0 to use a seed based on the current time).\n" +"\n" +"Test Output:\n" +" @G--" GTEST_FLAG_PREFIX_ "color=@Y(@Gyes@Y|@Gno@Y|@Gauto@Y)@D\n" +" Enable/disable colored output. The default is @Gauto@D.\n" +" -@G-" GTEST_FLAG_PREFIX_ "print_time=0@D\n" +" Don't print the elapsed time of each test.\n" +" @G--" GTEST_FLAG_PREFIX_ "output=xml@Y[@G:@YDIRECTORY_PATH@G" + GTEST_PATH_SEP_ "@Y|@G:@YFILE_PATH]@D\n" +" Generate an XML report in the given directory or with the given file\n" +" name. @YFILE_PATH@D defaults to @Gtest_details.xml@D.\n" +#if GTEST_CAN_STREAM_RESULTS_ +" @G--" GTEST_FLAG_PREFIX_ "stream_result_to=@YHOST@G:@YPORT@D\n" +" Stream test results to the given server.\n" +#endif // GTEST_CAN_STREAM_RESULTS_ +"\n" +"Assertion Behavior:\n" +#if GTEST_HAS_DEATH_TEST && !GTEST_OS_WINDOWS +" @G--" GTEST_FLAG_PREFIX_ "death_test_style=@Y(@Gfast@Y|@Gthreadsafe@Y)@D\n" +" Set the default death test style.\n" +#endif // GTEST_HAS_DEATH_TEST && !GTEST_OS_WINDOWS +" @G--" GTEST_FLAG_PREFIX_ "break_on_failure@D\n" +" Turn assertion failures into debugger break-points.\n" +" @G--" GTEST_FLAG_PREFIX_ "throw_on_failure@D\n" +" Turn assertion failures into C++ exceptions.\n" +" @G--" GTEST_FLAG_PREFIX_ "catch_exceptions=0@D\n" +" Do not report exceptions as test failures. Instead, allow them\n" +" to crash the program or throw a pop-up (on Windows).\n" +"\n" +"Except for @G--" GTEST_FLAG_PREFIX_ "list_tests@D, you can alternatively set " + "the corresponding\n" +"environment variable of a flag (all letters in upper-case). For example, to\n" +"disable colored text output, you can either specify @G--" GTEST_FLAG_PREFIX_ + "color=no@D or set\n" +"the @G" GTEST_FLAG_PREFIX_UPPER_ "COLOR@D environment variable to @Gno@D.\n" +"\n" +"For more information, please read the " GTEST_NAME_ " documentation at\n" +"@G" GTEST_PROJECT_URL_ "@D. If you find a bug in " GTEST_NAME_ "\n" +"(not one in your own code or tests), please report it to\n" +"@G<" GTEST_DEV_EMAIL_ ">@D.\n"; + +// Parses the command line for Google Test flags, without initializing +// other parts of Google Test. The type parameter CharType can be +// instantiated to either char or wchar_t. +template +void ParseGoogleTestFlagsOnlyImpl(int* argc, CharType** argv) { + for (int i = 1; i < *argc; i++) { + const String arg_string = StreamableToString(argv[i]); + const char* const arg = arg_string.c_str(); + + using internal::ParseBoolFlag; + using internal::ParseInt32Flag; + using internal::ParseStringFlag; + + // Do we see a Google Test flag? + if (ParseBoolFlag(arg, kAlsoRunDisabledTestsFlag, + >EST_FLAG(also_run_disabled_tests)) || + ParseBoolFlag(arg, kBreakOnFailureFlag, + >EST_FLAG(break_on_failure)) || + ParseBoolFlag(arg, kCatchExceptionsFlag, + >EST_FLAG(catch_exceptions)) || + ParseStringFlag(arg, kColorFlag, >EST_FLAG(color)) || + ParseStringFlag(arg, kDeathTestStyleFlag, + >EST_FLAG(death_test_style)) || + ParseBoolFlag(arg, kDeathTestUseFork, + >EST_FLAG(death_test_use_fork)) || + ParseStringFlag(arg, kFilterFlag, >EST_FLAG(filter)) || + ParseStringFlag(arg, kInternalRunDeathTestFlag, + >EST_FLAG(internal_run_death_test)) || + ParseBoolFlag(arg, kListTestsFlag, >EST_FLAG(list_tests)) || + ParseStringFlag(arg, kOutputFlag, >EST_FLAG(output)) || + ParseBoolFlag(arg, kPrintTimeFlag, >EST_FLAG(print_time)) || + ParseInt32Flag(arg, kRandomSeedFlag, >EST_FLAG(random_seed)) || + ParseInt32Flag(arg, kRepeatFlag, >EST_FLAG(repeat)) || + ParseBoolFlag(arg, kShuffleFlag, >EST_FLAG(shuffle)) || + ParseInt32Flag(arg, kStackTraceDepthFlag, + >EST_FLAG(stack_trace_depth)) || + ParseStringFlag(arg, kStreamResultToFlag, + >EST_FLAG(stream_result_to)) || + ParseBoolFlag(arg, kThrowOnFailureFlag, + >EST_FLAG(throw_on_failure)) + ) { + // Yes. Shift the remainder of the argv list left by one. Note + // that argv has (*argc + 1) elements, the last one always being + // NULL. The following loop moves the trailing NULL element as + // well. + for (int j = i; j != *argc; j++) { + argv[j] = argv[j + 1]; + } + + // Decrements the argument count. + (*argc)--; + + // We also need to decrement the iterator as we just removed + // an element. + i--; + } else if (arg_string == "--help" || arg_string == "-h" || + arg_string == "-?" || arg_string == "/?" || + HasGoogleTestFlagPrefix(arg)) { + // Both help flag and unrecognized Google Test flags (excluding + // internal ones) trigger help display. + g_help_flag = true; + } + } + + if (g_help_flag) { + // We print the help here instead of in RUN_ALL_TESTS(), as the + // latter may not be called at all if the user is using Google + // Test with another testing framework. + PrintColorEncoded(kColorEncodedHelpMessage); + } +} + +// Parses the command line for Google Test flags, without initializing +// other parts of Google Test. +void ParseGoogleTestFlagsOnly(int* argc, char** argv) { + ParseGoogleTestFlagsOnlyImpl(argc, argv); +} +void ParseGoogleTestFlagsOnly(int* argc, wchar_t** argv) { + ParseGoogleTestFlagsOnlyImpl(argc, argv); +} + +// The internal implementation of InitGoogleTest(). +// +// The type parameter CharType can be instantiated to either char or +// wchar_t. +template +void InitGoogleTestImpl(int* argc, CharType** argv) { + g_init_gtest_count++; + + // We don't want to run the initialization code twice. + if (g_init_gtest_count != 1) return; + + if (*argc <= 0) return; + + internal::g_executable_path = internal::StreamableToString(argv[0]); + +#if GTEST_HAS_DEATH_TEST + + g_argvs.clear(); + for (int i = 0; i != *argc; i++) { + g_argvs.push_back(StreamableToString(argv[i])); + } + +#endif // GTEST_HAS_DEATH_TEST + + ParseGoogleTestFlagsOnly(argc, argv); + GetUnitTestImpl()->PostFlagParsingInit(); +} + +} // namespace internal + +// Initializes Google Test. This must be called before calling +// RUN_ALL_TESTS(). In particular, it parses a command line for the +// flags that Google Test recognizes. Whenever a Google Test flag is +// seen, it is removed from argv, and *argc is decremented. +// +// No value is returned. Instead, the Google Test flag variables are +// updated. +// +// Calling the function for the second time has no user-visible effect. +void InitGoogleTest(int* argc, char** argv) { + internal::InitGoogleTestImpl(argc, argv); +} + +// This overloaded version can be used in Windows programs compiled in +// UNICODE mode. +void InitGoogleTest(int* argc, wchar_t** argv) { + internal::InitGoogleTestImpl(argc, argv); +} + +} // namespace testing diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest_main.cc b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest_main.cc new file mode 100644 index 0000000000..7aa9914ca9 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/gtest-1.6.0/src/gtest_main.cc @@ -0,0 +1,39 @@ +// Copyright 2006, Google Inc. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +#include + +#include "gtest/gtest.h" + +GTEST_API_ int main(int argc, char **argv) { + std::cout << "Running main() from gtest_main.cc\n"; + + testing::InitGoogleTest(&argc, argv); + return RUN_ALL_TESTS(); +} diff --git a/integration-tests/testdata/smoketest_project_utf8_bom/tests/unittests/test_component1.cc b/integration-tests/testdata/smoketest_project_utf8_bom/tests/unittests/test_component1.cc new file mode 100644 index 0000000000..1f605b4e24 --- /dev/null +++ b/integration-tests/testdata/smoketest_project_utf8_bom/tests/unittests/test_component1.cc @@ -0,0 +1,32 @@ +#include +using namespace std; + +#include +#include + +namespace { + class Component1Test : public ::testing::Test { + protected: + Bar bar; + }; + + TEST_F(Component1Test, foo_successfull) { + EXPECT_EQ(bar.foo(), 111); + } + + TEST_F(Component1Test, foo_failing) { + EXPECT_EQ(bar.foo(), 112); + } + + TEST_F(Component1Test, foo_throwing) { + throw "BOOM"; + } + + TEST_F(Component1Test, DISABLED_foo_skipped) { + ASSERT_EQ(1, 1); + } + + TEST_F(Component1Test, foo_leaking) { + Bar().do_valgrind_errors(); + } +} diff --git a/integration-tests/testdata/vs_project/reports/warnings.log b/integration-tests/testdata/vs_project/reports/warnings.log index bca464f5d8..2538b7e46e 100644 Binary files a/integration-tests/testdata/vs_project/reports/warnings.log and b/integration-tests/testdata/vs_project/reports/warnings.log differ diff --git a/integration-tests/testdata/vs_project/src/main.cpp b/integration-tests/testdata/vs_project/src/main.cpp index 41ecad6d2b..de44689d2e 100644 Binary files a/integration-tests/testdata/vs_project/src/main.cpp and b/integration-tests/testdata/vs_project/src/main.cpp differ diff --git a/pom.xml b/pom.xml index dc30308ce4..78978c3927 100644 --- a/pom.xml +++ b/pom.xml @@ -225,11 +225,12 @@ + cxx-squid-bridge cxx-squid cxx-checks cxx-sensors + cxx-sslr-toolkit sonar-cxx-plugin - sslr-cxx-toolkit integration-tests @@ -262,7 +263,6 @@ 11 3.8.1 1.24.0.633 - 2.6.1 7.9 @@ -313,37 +313,6 @@
- - org.sonarsource.sslr-squid-bridge - sslr-squid-bridge - ${sslr-squid-bridge.version} - - - org.codehaus.sonar.sslr - sslr-core - - - org.codehaus.sonar.sslr - sslr-xpath - - - org.codehaus.sonar - sonar-plugin-api - - - org.picocontainer - picocontainer - - - org.slf4j - slf4j-api - - - org.slf4j - jcl-over-slf4j - - - junit junit diff --git a/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CustomCxxRulesDefinition.java b/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CustomCxxRulesDefinition.java index 0a63206502..e6918ab2ee 100644 --- a/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CustomCxxRulesDefinition.java +++ b/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CustomCxxRulesDefinition.java @@ -23,7 +23,7 @@ import org.sonar.api.resources.Language; import org.sonar.api.scanner.ScannerSide; import org.sonar.api.server.rule.RulesDefinition; -import org.sonar.squidbridge.annotations.AnnotationBasedRulesDefinition; +import org.sonar.cxx.squidbridge.annotations.AnnotationBasedRulesDefinition; /** * diff --git a/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxChecks.java b/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxChecks.java index 7ec9f2ae90..1ba436fbcf 100644 --- a/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxChecks.java +++ b/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxChecks.java @@ -30,7 +30,7 @@ import org.sonar.api.batch.rule.CheckFactory; import org.sonar.api.batch.rule.Checks; import org.sonar.api.rule.RuleKey; -import org.sonar.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.SquidAstVisitor; public final class CxxChecks { diff --git a/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxRuleRepository.java b/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxRuleRepository.java index e857352edb..9cd3431a9c 100644 --- a/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxRuleRepository.java +++ b/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxRuleRepository.java @@ -21,7 +21,7 @@ import org.sonar.api.server.rule.RulesDefinition; import org.sonar.cxx.checks.CheckList; -import org.sonar.squidbridge.annotations.AnnotationBasedRulesDefinition; +import org.sonar.cxx.squidbridge.annotations.AnnotationBasedRulesDefinition; public class CxxRuleRepository implements RulesDefinition { diff --git a/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxSquidSensor.java b/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxSquidSensor.java index 01ad3807c0..d0e2d615a7 100644 --- a/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxSquidSensor.java +++ b/sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxSquidSensor.java @@ -60,15 +60,15 @@ import org.sonar.cxx.config.CxxSquidConfiguration; import org.sonar.cxx.config.MsBuild; import org.sonar.cxx.sensors.utils.CxxUtils; +import org.sonar.cxx.squidbridge.AstScanner; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.api.SourceCode; +import org.sonar.cxx.squidbridge.api.SourceFile; +import org.sonar.cxx.squidbridge.indexer.QueryByType; import org.sonar.cxx.visitors.CxxCpdVisitor; import org.sonar.cxx.visitors.CxxHighlighterVisitor; import org.sonar.cxx.visitors.CxxPublicApiVisitor; import org.sonar.cxx.visitors.MultiLocatitionSquidCheck; -import org.sonar.squidbridge.AstScanner; -import org.sonar.squidbridge.SquidAstVisitor; -import org.sonar.squidbridge.api.SourceCode; -import org.sonar.squidbridge.api.SourceFile; -import org.sonar.squidbridge.indexer.QueryByType; /** * {@inheritDoc} @@ -299,13 +299,7 @@ public void execute(SensorContext context) { context.fileSystem().predicates().and(context.fileSystem().predicates().hasLanguage("cxx"), context.fileSystem().predicates().hasType(InputFile.Type.MAIN)) ); - - var files = new ArrayList(); - for (var file : inputFiles) { - files.add(new File(file.uri().getPath())); - } - - scanner.scanFiles(files); + scanner.scanInputFiles(inputFiles); Collection squidSourceFiles = scanner.getIndex().search(new QueryByType(SourceFile.class)); save(squidSourceFiles); diff --git a/sonar-cxx-plugin/src/test/java/org/sonar/plugins/cxx/CustomCxxRulesDefinitionTest.java b/sonar-cxx-plugin/src/test/java/org/sonar/plugins/cxx/CustomCxxRulesDefinitionTest.java index 8a20e927d8..26f35a6cb3 100644 --- a/sonar-cxx-plugin/src/test/java/org/sonar/plugins/cxx/CustomCxxRulesDefinitionTest.java +++ b/sonar-cxx-plugin/src/test/java/org/sonar/plugins/cxx/CustomCxxRulesDefinitionTest.java @@ -28,7 +28,7 @@ import org.sonar.check.Rule; import org.sonar.check.RuleProperty; import org.sonar.cxx.tag.Tag; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.checks.SquidCheck; public class CustomCxxRulesDefinitionTest { diff --git a/sonar-cxx-plugin/src/test/java/org/sonar/plugins/cxx/CxxChecksTest.java b/sonar-cxx-plugin/src/test/java/org/sonar/plugins/cxx/CxxChecksTest.java index ffe3eda990..d0f076671e 100644 --- a/sonar-cxx-plugin/src/test/java/org/sonar/plugins/cxx/CxxChecksTest.java +++ b/sonar-cxx-plugin/src/test/java/org/sonar/plugins/cxx/CxxChecksTest.java @@ -34,8 +34,8 @@ import org.sonar.api.rule.RuleKey; import org.sonar.api.server.rule.RulesDefinition; import org.sonar.check.Rule; -import org.sonar.squidbridge.SquidAstVisitor; -import org.sonar.squidbridge.checks.SquidCheck; +import org.sonar.cxx.squidbridge.SquidAstVisitor; +import org.sonar.cxx.squidbridge.checks.SquidCheck; public class CxxChecksTest {