cmDepends.cxx 8.54 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*=========================================================================

  Program:   CMake - Cross-Platform Makefile Generator
  Module:    $RCSfile$
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

  Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#include "cmDepends.h"

19 20
#include "cmLocalGenerator.h"
#include "cmMakefile.h"
21 22
#include "cmGeneratedFileStream.h"
#include "cmSystemTools.h"
23
#include "cmFileTimeComparison.h"
Bill Hoffman's avatar
Bill Hoffman committed
24
#include <string.h>
25

26
//----------------------------------------------------------------------------
27
cmDepends::cmDepends(cmLocalGenerator* lg, const char* targetDir):
28
  CompileDirectory(),
29
  LocalGenerator(lg),
30 31
  Verbose(false),
  FileComparison(0),
32
  TargetDirectory(targetDir),
Ken Martin's avatar
Ken Martin committed
33 34 35
  MaxPath(cmSystemTools::GetMaximumFilePathLength()),
  Dependee(new char[MaxPath]),
  Depender(new char[MaxPath])
36
{
37 38 39 40 41
}

//----------------------------------------------------------------------------
cmDepends::~cmDepends()
{
Ken Martin's avatar
Ken Martin committed
42 43
  delete [] this->Dependee;
  delete [] this->Depender;
44 45
}

46
//----------------------------------------------------------------------------
47 48
bool cmDepends::Write(std::ostream &makeDepends,
                      std::ostream &internalDepends)
49
{
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
  // Lookup the set of sources to scan.
  std::string srcLang = "CMAKE_DEPENDS_CHECK_";
  srcLang += this->Language;
  cmMakefile* mf = this->LocalGenerator->GetMakefile();
  const char* srcStr = mf->GetSafeDefinition(srcLang.c_str());
  std::vector<std::string> pairs;
  cmSystemTools::ExpandListArgument(srcStr, pairs);

  for(std::vector<std::string>::iterator si = pairs.begin();
      si != pairs.end();)
    {
    // Get the source and object file.
    std::string const& src = *si++;
    if(si == pairs.end()) { break; }
    std::string obj = *si++;

    // Make sure the object file is relative to the top of the build tree.
    obj = this->LocalGenerator->Convert(obj.c_str(),
                                        cmLocalGenerator::HOME_OUTPUT,
                                        cmLocalGenerator::MAKEFILE);

    // Write the dependencies for this pair.
    if(!this->WriteDependencies(src.c_str(), obj.c_str(),
                                makeDepends, internalDepends))
      {
      return false;
      }
    }

79 80 81 82 83 84 85
  return this->Finalize(makeDepends, internalDepends);
}

//----------------------------------------------------------------------------
bool cmDepends::Finalize(std::ostream&,
                         std::ostream&)
{
86
  return true;
87 88 89
}

//----------------------------------------------------------------------------
90 91
bool cmDepends::Check(const char *makeFile, const char *internalFile,
                      std::map<std::string, DependencyVector>& validDeps)
92
{
93 94
  // Dependency checks must be done in proper working directory.
  std::string oldcwd = ".";
Ken Martin's avatar
Ken Martin committed
95
  if(this->CompileDirectory != ".")
96
    {
97 98 99
    // Get the CWD but do not call CollapseFullPath because
    // we only need it to cd back, and the form does not matter
    oldcwd = cmSystemTools::GetCurrentWorkingDirectory(false);
Ken Martin's avatar
Ken Martin committed
100
    cmSystemTools::ChangeDirectory(this->CompileDirectory.c_str());
101 102
    }

103
  // Check whether dependencies must be regenerated.
104
  bool okay = true;
105
  std::ifstream fin(internalFile);
106
  if(!(fin && this->CheckDependencies(fin, validDeps)))
107 108
    {
    // Clear all dependencies so they will be regenerated.
109
    this->Clear(makeFile);
110 111
    cmSystemTools::RemoveFile(internalFile);
    okay = false;
112
    }
113 114 115 116 117 118

  // Restore working directory.
  if(oldcwd != ".")
    {
    cmSystemTools::ChangeDirectory(oldcwd.c_str());
    }
119 120

  return okay;
121 122 123
}

//----------------------------------------------------------------------------
124
void cmDepends::Clear(const char *file)
125
{
126
  // Print verbose output.
Ken Martin's avatar
Ken Martin committed
127
  if(this->Verbose)
128 129
    {
    cmOStringStream msg;
130
    msg << "Clearing dependencies in \"" << file << "\"." << std::endl;
131 132 133
    cmSystemTools::Stdout(msg.str().c_str());
    }

134
  // Write an empty dependency file.
135
  cmGeneratedFileStream depFileStream(file);
136
  depFileStream
137
    << "# Empty dependencies file\n"
138 139 140
    << "# This may be replaced when dependencies are built." << std::endl;
}

141 142 143 144 145 146 147 148
//----------------------------------------------------------------------------
bool cmDepends::WriteDependencies(const char*, const char*,
                                  std::ostream&, std::ostream&)
{
  // This should be implemented by the subclass.
  return false;
}

149
//----------------------------------------------------------------------------
150 151
bool cmDepends::CheckDependencies(std::istream& internalDepends,
                            std::map<std::string, DependencyVector>& validDeps)
152 153 154 155 156
{
  // Parse dependencies from the stream.  If any dependee is missing
  // or newer than the depender then dependencies should be
  // regenerated.
  bool okay = true;
157
  bool dependerExists = false;
158 159
  DependencyVector* currentDependencies = 0;

Ken Martin's avatar
Ken Martin committed
160
  while(internalDepends.getline(this->Dependee, this->MaxPath))
161
    {
Ken Martin's avatar
Ken Martin committed
162 163
    if ( this->Dependee[0] == 0 || this->Dependee[0] == '#' || 
         this->Dependee[0] == '\r' )
164 165 166 167
      {
      continue;
      }
    size_t len = internalDepends.gcount()-1;
Ken Martin's avatar
Ken Martin committed
168
    if ( this->Dependee[len-1] == '\r' )
169 170
      {
      len --;
Ken Martin's avatar
Ken Martin committed
171
      this->Dependee[len] = 0;
172
      }
Ken Martin's avatar
Ken Martin committed
173
    if ( this->Dependee[0] != ' ' )
174
      {
Ken Martin's avatar
Ken Martin committed
175
      memcpy(this->Depender, this->Dependee, len+1);
176 177 178 179 180
      // Calling FileExists() for the depender here saves in many cases 50%
      // of the calls to FileExists() further down in the loop. E.g. for
      // kdelibs/khtml this reduces the number of calls from 184k down to 92k,
      // or the time for cmake -E cmake_depends from 0.3 s down to 0.21 s.
      dependerExists = cmSystemTools::FileExists(this->Depender);
181 182 183
      DependencyVector tmp;
      validDeps[this->Depender] = tmp;
      currentDependencies = &validDeps[this->Depender];
184 185 186 187 188 189 190 191 192 193 194 195 196
      continue;
      }
    /*
    // Parse the dependency line.
    if(!this->ParseDependency(line.c_str()))
      {
      continue;
      }
      */

    // Dependencies must be regenerated if the dependee does not exist
    // or if the depender exists and is older than the dependee.
    bool regenerate = false;
Ken Martin's avatar
Ken Martin committed
197 198
    const char* dependee = this->Dependee+1;
    const char* depender = this->Depender;
199 200 201 202 203
    if (currentDependencies != 0)
      {
      currentDependencies->push_back(dependee);
      }

204 205 206 207 208 209
    if(!cmSystemTools::FileExists(dependee))
      {
      // The dependee does not exist.
      regenerate = true;

      // Print verbose output.
Ken Martin's avatar
Ken Martin committed
210
      if(this->Verbose)
211 212 213 214 215 216 217 218
        {
        cmOStringStream msg;
        msg << "Dependee \"" << dependee
            << "\" does not exist for depender \""
            << depender << "\"." << std::endl;
        cmSystemTools::Stdout(msg.str().c_str());
        }
      }
219
    else if(dependerExists)
220 221 222
      {
      // The dependee and depender both exist.  Compare file times.
      int result = 0;
Ken Martin's avatar
Ken Martin committed
223
      if((!this->FileComparison->FileTimeCompare(depender, dependee,
224 225 226 227 228 229
                                             &result) || result < 0))
        {
        // The depender is older than the dependee.
        regenerate = true;

        // Print verbose output.
Ken Martin's avatar
Ken Martin committed
230
        if(this->Verbose)
231 232 233 234 235 236 237 238 239 240 241 242 243 244
          {
          cmOStringStream msg;
          msg << "Dependee \"" << dependee
              << "\" is newer than depender \""
              << depender << "\"." << std::endl;
          cmSystemTools::Stdout(msg.str().c_str());
          }
        }
      }
    if(regenerate)
      {
      // Dependencies must be regenerated.
      okay = false;

245 246 247 248 249 250 251 252
      // Remove the information of this depender from the map, it needs
      // to be rescanned
      if (currentDependencies != 0)
        {
        validDeps.erase(this->Depender);
        currentDependencies = 0;
        }

253
      // Remove the depender to be sure it is rebuilt.
254 255 256 257 258
      if (dependerExists)
        {
        cmSystemTools::RemoveFile(depender);
        dependerExists = false;
        }
259 260 261 262 263 264
      }
    }

  return okay;
}

265 266 267 268 269 270 271 272 273 274 275 276
//----------------------------------------------------------------------------
void cmDepends::SetIncludePathFromLanguage(const char* lang)
{
  std::string includePathVar = "CMAKE_";
  includePathVar += lang;
  includePathVar += "_INCLUDE_PATH";
  cmMakefile* mf = this->LocalGenerator->GetMakefile();
  if(const char* includePath = mf->GetDefinition(includePathVar.c_str()))
    {
    cmSystemTools::ExpandListArgument(includePath, this->IncludePath);
    }
}