cmState.h 7.08 KB
Newer Older
Stephen Kelly's avatar
Stephen Kelly committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/*============================================================================
  CMake - Cross Platform Makefile Generator
  Copyright 2015 Stephen Kelly <steveire@gmail.com>

  Distributed under the OSI-approved BSD License (the "License");
  see accompanying file Copyright.txt for details.

  This software is distributed WITHOUT ANY WARRANTY; without even the
  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  See the License for more information.
============================================================================*/
#ifndef cmState_h
#define cmState_h

15
#include "cmStandardIncludes.h"
16
#include "cmPropertyDefinitionMap.h"
17
#include "cmPropertyMap.h"
Stephen Kelly's avatar
Stephen Kelly committed
18
19

class cmake;
20
class cmCommand;
Stephen Kelly's avatar
Stephen Kelly committed
21
22
23

class cmState
{
Stephen Kelly's avatar
Stephen Kelly committed
24
25
  typedef std::vector<std::string>::size_type PositionType;
  friend class Snapshot;
Stephen Kelly's avatar
Stephen Kelly committed
26
27
public:
  cmState(cmake* cm);
28
  ~cmState();
Stephen Kelly's avatar
Stephen Kelly committed
29

Stephen Kelly's avatar
Stephen Kelly committed
30
31
32
33
  class Snapshot {
  public:
    Snapshot(cmState* state = 0, PositionType position = 0);

34
35
36
37
38
    const char* GetCurrentSourceDirectory() const;
    void SetCurrentSourceDirectory(std::string const& dir);
    const char* GetCurrentBinaryDirectory() const;
    void SetCurrentBinaryDirectory(std::string const& dir);

39
40
41
    std::vector<std::string> const& GetCurrentSourceDirectoryComponents();
    std::vector<std::string> const& GetCurrentBinaryDirectoryComponents();

42
43
44
45
46
    const char* GetRelativePathTopSource() const;
    const char* GetRelativePathTopBinary() const;
    void SetRelativePathTopSource(const char* dir);
    void SetRelativePathTopBinary(const char* dir);

47
48
49
    bool IsValid() const;
    Snapshot GetParent() const;

50
51
52
53
  private:
    void ComputeRelativePathTopSource();
    void ComputeRelativePathTopBinary();

Stephen Kelly's avatar
Stephen Kelly committed
54
55
56
57
58
59
  private:
    friend class cmState;
    cmState* State;
    cmState::PositionType Position;
  };

60
  Snapshot CreateBaseSnapshot();
61
  Snapshot CreateBuildsystemDirectorySnapshot(Snapshot originSnapshot);
Stephen Kelly's avatar
Stephen Kelly committed
62

63
64
65
66
  enum CacheEntryType{ BOOL=0, PATH, FILEPATH, STRING, INTERNAL,STATIC,
                       UNINITIALIZED };
  static CacheEntryType StringToCacheEntryType(const char*);
  static const char* CacheEntryTypeToString(CacheEntryType);
Stephen Kelly's avatar
Stephen Kelly committed
67
68
69
70
71
  static bool IsCacheEntryType(std::string const& key);

  std::vector<std::string> GetCacheEntryKeys() const;
  const char* GetCacheEntryValue(std::string const& key) const;
  const char* GetInitializedCacheValue(std::string const& key) const;
72
  CacheEntryType GetCacheEntryType(std::string const& key) const;
Stephen Kelly's avatar
Stephen Kelly committed
73
74
75
76
  void SetCacheEntryValue(std::string const& key, std::string const& value);
  void SetCacheValue(std::string const& key, std::string const& value);

  void AddCacheEntry(const std::string& key, const char* value,
77
                     const char* helpString, CacheEntryType type);
Stephen Kelly's avatar
Stephen Kelly committed
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
  void RemoveCacheEntry(std::string const& key);

  void SetCacheEntryProperty(std::string const& key,
                             std::string const& propertyName,
                             std::string const& value);
  void SetCacheEntryBoolProperty(std::string const& key,
                                 std::string const& propertyName,
                                 bool value);
  const char* GetCacheEntryProperty(std::string const& key,
                                    std::string const& propertyName);
  bool GetCacheEntryPropertyAsBool(std::string const& key,
                                   std::string const& propertyName);
  void AppendCacheEntryProperty(std::string const& key,
                                const std::string& property,
                                const std::string& value,
                                bool asString = false);
  void RemoveCacheEntryProperty(std::string const& key,
                                std::string const& propertyName);

97
  void Reset();
98
99
100
101
102
103
104
105
106
107
108
109
110
111
  // Define a property
  void DefineProperty(const std::string& name, cmProperty::ScopeType scope,
                      const char *ShortDescription,
                      const char *FullDescription,
                      bool chain = false);

  // get property definition
  cmPropertyDefinition *GetPropertyDefinition
  (const std::string& name, cmProperty::ScopeType scope);

  // Is a property defined?
  bool IsPropertyDefined(const std::string& name, cmProperty::ScopeType scope);
  bool IsPropertyChained(const std::string& name, cmProperty::ScopeType scope);

112
113
114
  void SetLanguageEnabled(std::string const& l);
  bool GetLanguageEnabled(std::string const& l) const;
  std::vector<std::string> GetEnabledLanguages() const;
115
  void SetEnabledLanguages(std::vector<std::string> const& langs);
116
  void ClearEnabledLanguages();
117

118
119
120
  bool GetIsInTryCompile() const;
  void SetIsInTryCompile(bool b);

121
122
123
124
125
126
127
  cmCommand* GetCommand(std::string const& name) const;
  void AddCommand(cmCommand* command);
  void RemoveUnscriptableCommands();
  void RenameCommand(std::string const& oldName, std::string const& newName);
  void RemoveUserDefinedCommands();
  std::vector<std::string> GetCommandNames() const;

128
129
130
131
132
133
  void SetGlobalProperty(const std::string& prop, const char *value);
  void AppendGlobalProperty(const std::string& prop,
                      const char *value,bool asString=false);
  const char *GetGlobalProperty(const std::string& prop);
  bool GetGlobalPropertyAsBool(const std::string& prop);

134
135
136
137
138
  const char* GetSourceDirectory() const;
  void SetSourceDirectory(std::string const& sourceDirectory);
  const char* GetBinaryDirectory() const;
  void SetBinaryDirectory(std::string const& binaryDirectory);

139
140
141
  std::vector<std::string> const& GetSourceDirectoryComponents() const;
  std::vector<std::string> const& GetBinaryDirectoryComponents() const;

142
143
144
145
146
147
148
149
150
151
152
153
154
  void SetWindowsShell(bool windowsShell);
  bool UseWindowsShell() const;
  void SetWindowsVSIDE(bool windowsVSIDE);
  bool UseWindowsVSIDE() const;
  void SetWatcomWMake(bool watcomWMake);
  bool UseWatcomWMake() const;
  void SetMinGWMake(bool minGWMake);
  bool UseMinGWMake() const;
  void SetNMake(bool nMake);
  bool UseNMake() const;
  void SetMSYSShell(bool mSYSShell);
  bool UseMSYSShell() const;

Stephen Kelly's avatar
Stephen Kelly committed
155
private:
156
  std::map<cmProperty::ScopeType, cmPropertyDefinitionMap> PropertyDefinitions;
157
  std::vector<std::string> EnabledLanguages;
158
  std::map<std::string, cmCommand*> Commands;
159
  cmPropertyMap GlobalProperties;
Stephen Kelly's avatar
Stephen Kelly committed
160
  cmake* CMakeInstance;
161
162
  std::vector<std::string> Locations;
  std::vector<std::string> OutputLocations;
Stephen Kelly's avatar
Stephen Kelly committed
163
  std::vector<PositionType> ParentPositions;
164

165
166
  std::vector<std::vector<std::string> > CurrentSourceDirectoryComponents;
  std::vector<std::vector<std::string> > CurrentBinaryDirectoryComponents;
167
168
169
170
171
172
173
  // The top-most directories for relative path conversion.  Both the
  // source and destination location of a relative path conversion
  // must be underneath one of these directories (both under source or
  // both under binary) in order for the relative path to be evaluated
  // safely by the build tools.
  std::vector<std::string> RelativePathTopSource;
  std::vector<std::string> RelativePathTopBinary;
174

175
176
  std::vector<std::string> SourceDirectoryComponents;
  std::vector<std::string> BinaryDirectoryComponents;
177
178
  std::string SourceDirectory;
  std::string BinaryDirectory;
179
  bool IsInTryCompile;
180
181
182
183
184
185
  bool WindowsShell;
  bool WindowsVSIDE;
  bool WatcomWMake;
  bool MinGWMake;
  bool NMake;
  bool MSYSShell;
Stephen Kelly's avatar
Stephen Kelly committed
186
187
188
};

#endif