View Issue Details [ Jump to Notes ]

[ Print ]

Project

Category

View Status

Date Submitted

Last Update

0016040

CMake

public

2016-03-30 16:57

2016-06-10 14:31

Reporter

Colin Cornaby

Assigned To

Gregor Jasny

Priority

high

Severity

major

Reproducibility

always

Status

closed

Resolution

moved

Platform

Xcode 7.3

Mac OS

OS Version

10.11

Product Version

CMake 3.5.1

Target Version

Fixed in Version

Summary

0016040: Generated Xcode Projects Have Wrong Paths to Object Library Dependencies

Description

We have a CMake project that has object libraries, and then a parent build target that wraps those object libraries into a static library. When I generate the Xcode output, the parent build target is referencing different paths than what the .o's were outputted to.

I have a patch that fixes the issue, but I wanted to open a bug first, especially if I'm duplicating something (apologies, this is my first CMake bug.)

The section of code that seems to be the issue in the Xcode generator is here:
cmGlobalXCodeGenerator::GetObjectsNormalDirectory(
  const std::string &projName,
  const std::string &configName,
  const cmGeneratorTarget *t) const
{
  std::string dir =
    t->GetLocalGenerator()->GetCurrentBinaryDirectory();
  dir += "/";
  dir += projName;
  dir += ".build/";
  dir += configName;
  dir += "/";
  dir += t->GetName();
  dir += ".build/Objects-normal/";

  return dir;
}

There are a few things wrong here:
- The configuration name should be part of this path. Specifically the section of that path that is "foo.build/release" should be "foo.build/release-iphoneos". This behavior could be different for Mac targets, but I'm pretty sure it isn't. One reason I'm not straight submitting the patch yet.
- The .o files get written to the temporary objects directory, not the binary output directory. I've wrapped this in a new function:
std::string
cmGlobalXCodeGenerator::GetTemporaryFilesDirectory(
                                                  const std::string &projName,
                                                  const std::string &configName,
                                                  const cmGeneratorTarget *t) const
{
    std::string dir =
    t->GetLocalGenerator()->GetCurrentBinaryDirectory();
    dir += "/";
    dir += projName;
    dir += ".build/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)/";

    return dir;
}

I've then altered a few functions. GetObjectsNormalDirectory becomes:
//----------------------------------------------------------------------------
std::string
cmGlobalXCodeGenerator::GetObjectsNormalDirectory(
  const std::string &projName,
  const std::string &configName,
  const cmGeneratorTarget *t) const
{
    std::string dir = GetTemporaryFilesDirectory(projName, configName, t);
  dir += t->GetName();
  dir += ".build/Objects-normal/";

  return dir;
}

The build setting creation gets altered a bit a well with:
if(this->XcodeVersion >= 21)
      {
      std::string pncdir = this->GetObjectsNormalDirectory(
                                                           this->CurrentProject, configName, gtgt);
      std::string tempdir = this->GetTemporaryFilesDirectory(
                                                           this->CurrentProject, configName, gtgt);
      buildSettings->AddAttribute("CONFIGURATION_BUILD_DIR",
                                  this->CreateString(pncdir.c_str()));
      buildSettings->AddAttribute("CONFIGURATION_TEMP_DIR",
                                      this->CreateString(tempdir.c_str()));
      }
    else
      {
      buildSettings->AddAttribute("OBJROOT",
                                  this->CreateString(pndir.c_str()));
      pndir = this->GetObjectsNormalDirectory(
        this->CurrentProject, configName, gtgt);
      }
    }

Again, mostly submitting this bug because I'm new to Cmake and I don't know if this is patching on top of behavior that is platform dependent. Please let me know if there is something I am missing here, or if I'm breaking something else with these patches!

(I'm attaching a Git patch as well)

Tags

No tags attached.

Attached Files

0001-Fixes-for-.o-generation.patch [^] (3,497 bytes) 2016-03-30 16:57 [Show Content] [Hide Content]

From 3ae23ea3405df5e8250d6638fce905967de0ff92 Mon Sep 17 00:00:00 2001
From: Colin Cornaby <colin.cornaby@digimarc.com>
Date: Wed, 30 Mar 2016 13:57:12 -0700
Subject: [PATCH] Fixes for .o generation

---
 Source/cmGlobalXCodeGenerator.cxx | 30 ++++++++++++++++++++++--------
 Source/cmGlobalXCodeGenerator.h   |  5 ++++-
 2 files changed, 26 insertions(+), 9 deletions(-)

diff --git a/Source/cmGlobalXCodeGenerator.cxx b/Source/cmGlobalXCodeGenerator.cxx
index 7c85281..bfaf5cf 100644
--- a/Source/cmGlobalXCodeGenerator.cxx
+++ b/Source/cmGlobalXCodeGenerator.cxx
@@ -2110,9 +2110,13 @@ void cmGlobalXCodeGenerator::CreateBuildSettings(cmGeneratorTarget* gtgt,
     if(this->XcodeVersion >= 21)
       {
       std::string pncdir = this->GetObjectsNormalDirectory(
-        this->CurrentProject, configName, gtgt);
+                                                           this->CurrentProject, configName, gtgt);
+      std::string tempdir = this->GetTemporaryFilesDirectory(
+                                                           this->CurrentProject, configName, gtgt);
       buildSettings->AddAttribute("CONFIGURATION_BUILD_DIR",
                                   this->CreateString(pncdir.c_str()));
+      buildSettings->AddAttribute("CONFIGURATION_TEMP_DIR",
+                                      this->CreateString(tempdir.c_str()));
       }
     else
       {
@@ -3625,13 +3629,7 @@ cmGlobalXCodeGenerator::GetObjectsNormalDirectory(
   const std::string &configName,
   const cmGeneratorTarget *t) const
 {
-  std::string dir =
-    t->GetLocalGenerator()->GetCurrentBinaryDirectory();
-  dir += "/";
-  dir += projName;
-  dir += ".build/";
-  dir += configName;
-  dir += "/";
+    std::string dir = GetTemporaryFilesDirectory(projName, configName, t);
   dir += t->GetName();
   dir += ".build/Objects-normal/";
 
@@ -3639,6 +3637,22 @@ cmGlobalXCodeGenerator::GetObjectsNormalDirectory(
 }
 
 //----------------------------------------------------------------------------
+std::string
+cmGlobalXCodeGenerator::GetTemporaryFilesDirectory(
+                                                  const std::string &projName,
+                                                  const std::string &configName,
+                                                  const cmGeneratorTarget *t) const
+{
+    std::string dir =
+    t->GetLocalGenerator()->GetCurrentBinaryDirectory();
+    dir += "/";
+    dir += projName;
+    dir += ".build/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)/";
+    
+    return dir;
+}
+
+//----------------------------------------------------------------------------
 void
 cmGlobalXCodeGenerator::CreateXCodeDependHackTarget(
   std::vector<cmXCodeObject*>& targets)
diff --git a/Source/cmGlobalXCodeGenerator.h b/Source/cmGlobalXCodeGenerator.h
index 862746f..805919e 100644
--- a/Source/cmGlobalXCodeGenerator.h
+++ b/Source/cmGlobalXCodeGenerator.h
@@ -230,7 +230,10 @@ private:
 
   std::string GetObjectsNormalDirectory(const std::string &projName,
     const std::string &configName,
-    const cmGeneratorTarget *t) const;
+                                        const cmGeneratorTarget *t) const;
+  std::string GetTemporaryFilesDirectory(const std::string &projName,
+                                        const std::string &configName,
+                                         const cmGeneratorTarget *t) const;
 
   void addObject(cmXCodeObject *obj);
   std::string PostBuildMakeTarget(std::string const& tName,
-- 
2.6.4 (Apple Git-63)

test.zip [^] (36,037 bytes) 2016-04-07 17:32

0001-Fixes-for-.o-generation-FIXED.patch [^] (3,252 bytes) 2016-04-14 18:02 [Show Content] [Hide Content]

From 3ae23ea3405df5e8250d6638fce905967de0ff92 Mon Sep 17 00:00:00 2001
From: Colin Cornaby <colin.cornaby@digimarc.com>
Date: Wed, 30 Mar 2016 13:57:12 -0700
Subject: [PATCH] Fixes for .o generation

---
 Source/cmGlobalXCodeGenerator.cxx | 30 ++++++++++++++++++++++--------
 Source/cmGlobalXCodeGenerator.h   |  5 ++++-
 2 files changed, 26 insertions(+), 9 deletions(-)

diff --git a/Source/cmGlobalXCodeGenerator.cxx b/Source/cmGlobalXCodeGenerator.cxx
index 7c85281..bfaf5cf 100644
--- a/Source/cmGlobalXCodeGenerator.cxx
+++ b/Source/cmGlobalXCodeGenerator.cxx
@@ -2110,9 +2110,13 @@ void cmGlobalXCodeGenerator::CreateBuildSettings(cmGeneratorTarget* gtgt,
     if(this->XcodeVersion >= 21)
       {
       std::string pncdir = this->GetObjectsNormalDirectory(
-        this->CurrentProject, configName, gtgt);
+        this->CurrentProject, configName, gtgt);
+      std::string tempdir = this->GetTemporaryFilesDirectory(
+        this->CurrentProject, configName, gtgt);
       buildSettings->AddAttribute("CONFIGURATION_BUILD_DIR",
                                   this->CreateString(pncdir.c_str()));
+      buildSettings->AddAttribute("CONFIGURATION_TEMP_DIR",
+                                  this->CreateString(tempdir.c_str()));
       }
     else
       {
@@ -3625,13 +3629,7 @@ cmGlobalXCodeGenerator::GetObjectsNormalDirectory(
   const std::string &configName,
   const cmGeneratorTarget *t) const
 {
-  std::string dir =
-    t->GetLocalGenerator()->GetCurrentBinaryDirectory();
-  dir += "/";
-  dir += projName;
-  dir += ".build/";
-  dir += configName;
-  dir += "/";
+  std::string dir = GetTemporaryFilesDirectory(projName, configName, t);
   dir += t->GetName();
   dir += ".build/Objects-normal/";
 
@@ -3639,6 +3637,22 @@ cmGlobalXCodeGenerator::GetObjectsNormalDirectory(
 }
 
 //----------------------------------------------------------------------------
+std::string
+cmGlobalXCodeGenerator::GetTemporaryFilesDirectory(
+  const std::string &projName,
+  const std::string &configName,
+  const cmGeneratorTarget *t) const
+{
+   std::string dir =
+   t->GetLocalGenerator()->GetCurrentBinaryDirectory();
+   dir += "/";
+   dir += projName;
+   dir += ".build/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)/";
+    
+   return dir;
+}
+
+//----------------------------------------------------------------------------
 void
 cmGlobalXCodeGenerator::CreateXCodeDependHackTarget(
   std::vector<cmXCodeObject*>& targets)
diff --git a/Source/cmGlobalXCodeGenerator.h b/Source/cmGlobalXCodeGenerator.h
index 862746f..805919e 100644
--- a/Source/cmGlobalXCodeGenerator.h
+++ b/Source/cmGlobalXCodeGenerator.h
@@ -230,7 +230,10 @@ private:
 
   std::string GetObjectsNormalDirectory(const std::string &projName,
     const std::string &configName,
-    const cmGeneratorTarget *t) const;
+                                        const cmGeneratorTarget *t) const;
+≈≈≈≈≈std::string GetTemporaryFilesDirectory(const std::string &projName,
+                                        const std::string &configName,
+                                         const cmGeneratorTarget *t) const;
 
   void addObject(cmXCodeObject *obj);
   std::string PostBuildMakeTarget(std::string const& tName,
-- 
2.6.4 (Apple Git-63)

Relationships

Notes
(0040773) Gregor Jasny (developer) 2016-03-31 04:00	Hello, your patch seems to have some whitespace/tab issues. could you please clean them up and re-attach the patch? I'd also like to create a test for this behavior. Could you please provide a minimal example and describe what to (not) look for in the generated xcodeproj? Thanks, Gregor

(0040777) Colin Cornaby (reporter) 2016-03-31 12:36	Thanks! I'm consuming this CMake project, but I don't know much about implementing a CMake project myself. I'll work with the author of this CMake project to boil it down to a sample. I'll clean up the white space too.

(0040826) Colin Cornaby (reporter) 2016-04-07 17:33	Sorry for the delay, had to learn some Cmake. The attached project is showing the problem for me. I have a sub target that is an object library, and a parent that depends on it. The parent target is reference the .o in a different place than the sub target object library is generating it. Command I'm using to invoke Cmake is: cmake -G "Xcode" -DCMAKE_BUILD_TYPE=Release

(0040827) Colin Cornaby (reporter) 2016-04-07 17:34	Oh, I also have cleaning up the white spaces on my list of things to do, just wanted to make sure as a CMake newbie I wasn't missing anything first.

(0040863) Colin Cornaby (reporter) 2016-04-14 18:02	Uploading a new diff. I think it fixes the spacing issues.

(0042971) Kitware Robot (administrator) 2016-06-10 14:29	Resolving issue as `moved`. This issue tracker is no longer used. Further discussion of this issue may take place in the current CMake Issues page linked in the banner at the top of this page.

Issue History
Date Modified	Username	Field	Change
2016-03-30 16:57	Colin Cornaby	New Issue
2016-03-30 16:57	Colin Cornaby	File Added: 0001-Fixes-for-.o-generation.patch
2016-03-31 03:58	Gregor Jasny	Assigned To	=> Gregor Jasny
2016-03-31 03:58	Gregor Jasny	Status	new => assigned
2016-03-31 04:00	Gregor Jasny	Note Added: 0040773
2016-03-31 12:36	Colin Cornaby	Note Added: 0040777
2016-04-07 17:32	Colin Cornaby	File Added: test.zip
2016-04-07 17:33	Colin Cornaby	Note Added: 0040826
2016-04-07 17:34	Colin Cornaby	Note Added: 0040827
2016-04-14 18:02	Colin Cornaby	Note Added: 0040863
2016-04-14 18:02	Colin Cornaby	File Added: 0001-Fixes-for-.o-generation-FIXED.patch
2016-06-10 14:29	Kitware Robot	Note Added: 0042971
2016-06-10 14:29	Kitware Robot	Status	assigned => resolved
2016-06-10 14:29	Kitware Robot	Resolution	open => moved
2016-06-10 14:31	Kitware Robot	Status	resolved => closed