Browse files

add a module for working with MSVC (cl.exe) behavior

This will be needed for performant builds on Windows.
  • Loading branch information...
1 parent edaf99e commit 5cc5615211b1cf83605a0fb7565cc640f4d7698e @evmar evmar committed Aug 12, 2012
Showing with 99 additions and 0 deletions.
  1. +3 −0 configure.py
  2. +35 −0 src/msvc_helper-win32.cc
  3. +29 −0 src/msvc_helper.h
  4. +32 −0 src/msvc_helper_test.cc
View
3 configure.py
@@ -249,6 +249,7 @@ def shell_escape(str):
if platform in ('mingw', 'windows'):
objs += cxx('subprocess-win32')
if platform == 'windows':
+ objs += cxx('msvc_helper-win32')
objs += cxx('minidump-win32')
objs += cc('getopt')
else:
@@ -318,6 +319,8 @@ def shell_escape(str):
'test',
'util_test']:
objs += cxx(name, variables=[('cflags', test_cflags)])
+if platform == 'windows':
+ objs += cxx('msvc_helper_test', variables=[('cflags', test_cflags)])
if platform != 'mingw' and platform != 'windows':
test_libs.append('-lpthread')
View
35 src/msvc_helper-win32.cc
@@ -0,0 +1,35 @@
+// Copyright 2011 Google Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "msvc_helper.h"
+
+#include <string.h>
+
+#include "string_piece.h"
+
+// static
+string CLWrapper::FilterShowIncludes(const string& line) {
+ static const char kMagicPrefix[] = "Note: including file: ";

The prefix string depends on the language version of MS Studio, thus the prefix should not be hard coded.

For instance the msvc wrapper in cmake passes the string as argument:
https://github.com/Kitware/CMake/blob/master/Source/cmcldeps.cxx

@evmar
evmar added a note Aug 15, 2012

Wow, thanks! I didn't realize this code existed in cmake. Do you think it will be useful for cmake if Ninja provides such a thing itself?
(Does cmake use this helper for any build system other than ninja? Is the extra binary a hassle to install?)

The helper in cmake is only used by the ninja generator, the extra binary in cmake is no problem when installing.

When ninja's helper could be used instead of cmake ones we would use ninja's but from cmakes point of view it's not that important.
The benefit for non-cmake projects using cl would be greater.

And yes, installing another binary is a bit more hassle, why not embedding the helper into ninja and switching to the helper code by an option?

@evmar
evmar added a note Aug 17, 2012

Hm, switching on an option is a good idea. I will try it out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
+ const char* in = line.c_str();
+ const char* end = in + line.size();
+
+ if (end - in > (int)sizeof(kMagicPrefix) - 1 &&
+ memcmp(in, kMagicPrefix, sizeof(kMagicPrefix) - 1) == 0) {
+ in += sizeof(kMagicPrefix) - 1;
+ while (*in == ' ')
+ ++in;
+ return line.substr(in - line.c_str());
+ }
+ return "";
+}
View
29 src/msvc_helper.h
@@ -0,0 +1,29 @@
+// Copyright 2011 Google Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include <string>
+#include <vector>
+using namespace std;
+
+struct StringPiece;
+
+/// Visual Studio's cl.exe requires some massaging to work with Ninja;
+/// for example, it emits include information on stderr in a funny
+/// format when building with /showIncludes. This class wraps a CL
+/// process and parses that output to extract the file list.
+struct CLWrapper {
+ /// Parse a line of cl.exe output and extract /showIncludes info.
+ /// If a dependency is extracted, returns a nonempty string.
+ static string FilterShowIncludes(const string& line);
+};
View
32 src/msvc_helper_test.cc
@@ -0,0 +1,32 @@
+// Copyright 2011 Google Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "msvc_helper.h"
+
+#include <gtest/gtest.h>
+
+#include "test.h"
+#include "util.h"
+
+TEST(MSVCHelperTest, ShowIncludes) {
+ ASSERT_EQ("", CLWrapper::FilterShowIncludes(""));
+
+ ASSERT_EQ("", CLWrapper::FilterShowIncludes("Sample compiler output"));
+ ASSERT_EQ("c:\\Some Files\\foobar.h",
+ CLWrapper::FilterShowIncludes("Note: including file: "
+ "c:\\Some Files\\foobar.h"));
+ ASSERT_EQ("c:\\initspaces.h",
+ CLWrapper::FilterShowIncludes("Note: including file: "
+ "c:\\initspaces.h"));
+}

0 comments on commit 5cc5615

Please sign in to comment.