clang  6.0.0svn
ArgumentsAdjusters.h
Go to the documentation of this file.
1 //===--- ArgumentsAdjusters.h - Command line arguments adjuster -*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file declares typedef ArgumentsAdjuster and functions to create several
11 // useful argument adjusters.
12 // ArgumentsAdjusters modify command line arguments obtained from a compilation
13 // database before they are used to run a frontend action.
14 //
15 //===----------------------------------------------------------------------===//
16 
17 #ifndef LLVM_CLANG_TOOLING_ARGUMENTSADJUSTERS_H
18 #define LLVM_CLANG_TOOLING_ARGUMENTSADJUSTERS_H
19 
20 #include "clang/Basic/LLVM.h"
21 #include "llvm/ADT/StringRef.h"
22 #include <functional>
23 #include <string>
24 #include <vector>
25 
26 namespace clang {
27 namespace tooling {
28 
29 /// \brief A sequence of command line arguments.
30 typedef std::vector<std::string> CommandLineArguments;
31 
32 /// \brief A prototype of a command line adjuster.
33 ///
34 /// Command line argument adjuster is responsible for command line arguments
35 /// modification before the arguments are used to run a frontend action.
36 typedef std::function<CommandLineArguments(
37  const CommandLineArguments &, StringRef Filename)> ArgumentsAdjuster;
38 
39 /// \brief Gets an argument adjuster that converts input command line arguments
40 /// to the "syntax check only" variant.
41 ArgumentsAdjuster getClangSyntaxOnlyAdjuster();
42 
43 /// \brief Gets an argument adjuster which removes output-related command line
44 /// arguments.
45 ArgumentsAdjuster getClangStripOutputAdjuster();
46 
47 /// \brief Gets an argument adjuster which removes dependency-file
48 /// related command line arguments.
49 ArgumentsAdjuster getClangStripDependencyFileAdjuster();
50 
52 
53 /// \brief Gets an argument adjuster which inserts \p Extra arguments in the
54 /// specified position.
55 ArgumentsAdjuster getInsertArgumentAdjuster(const CommandLineArguments &Extra,
57 
58 /// \brief Gets an argument adjuster which inserts an \p Extra argument in the
59 /// specified position.
60 ArgumentsAdjuster getInsertArgumentAdjuster(
61  const char *Extra,
63 
64 /// \brief Gets an argument adjuster which adjusts the arguments in sequence
65 /// with the \p First adjuster and then with the \p Second one.
66 ArgumentsAdjuster combineAdjusters(ArgumentsAdjuster First,
67  ArgumentsAdjuster Second);
68 
69 } // namespace tooling
70 } // namespace clang
71 
72 #endif // LLVM_CLANG_TOOLING_ARGUMENTSADJUSTERS_H
73 
ArgumentsAdjuster getInsertArgumentAdjuster(const CommandLineArguments &Extra, ArgumentInsertPosition Pos)
Gets an argument adjuster which inserts Extra arguments in the specified position.
ArgumentsAdjuster getClangStripDependencyFileAdjuster()
Gets an argument adjuster which removes dependency-file related command line arguments.
ArgumentsAdjuster combineAdjusters(ArgumentsAdjuster First, ArgumentsAdjuster Second)
Gets an argument adjuster which adjusts the arguments in sequence with the First adjuster and then wi...
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
StringRef Filename
Definition: Format.cpp:1316
ArgumentsAdjuster getClangStripOutputAdjuster()
Gets an argument adjuster which removes output-related command line arguments.
std::function< CommandLineArguments(const CommandLineArguments &, StringRef Filename)> ArgumentsAdjuster
A prototype of a command line adjuster.
Dataflow Directional Tag Classes.
std::vector< std::string > CommandLineArguments
A sequence of command line arguments.
ArgumentsAdjuster getClangSyntaxOnlyAdjuster()
Gets an argument adjuster that converts input command line arguments to the "syntax check only" varia...