summaryrefslogtreecommitdiff
path: root/cpp/src
diff options
context:
space:
mode:
Diffstat (limited to 'cpp/src')
-rw-r--r--cpp/src/Slice/Preprocessor.cpp6
-rw-r--r--cpp/src/Slice/Preprocessor.h1
-rw-r--r--cpp/src/Slice/Python.cpp209
-rw-r--r--cpp/src/Slice/PythonUtil.cpp81
-rw-r--r--cpp/src/Slice/PythonUtil.h11
5 files changed, 260 insertions, 48 deletions
diff --git a/cpp/src/Slice/Preprocessor.cpp b/cpp/src/Slice/Preprocessor.cpp
index e275bcd3024..568bc075cf7 100644
--- a/cpp/src/Slice/Preprocessor.cpp
+++ b/cpp/src/Slice/Preprocessor.cpp
@@ -68,6 +68,12 @@ Slice::Preprocessor::~Preprocessor()
}
string
+Slice::Preprocessor::getFileName()
+{
+ return _fileName;
+}
+
+string
Slice::Preprocessor::getBaseName()
{
string base(_fileName);
diff --git a/cpp/src/Slice/Preprocessor.h b/cpp/src/Slice/Preprocessor.h
index 3e017723756..70ef5c2dc5b 100644
--- a/cpp/src/Slice/Preprocessor.h
+++ b/cpp/src/Slice/Preprocessor.h
@@ -40,6 +40,7 @@ public:
const std::vector<std::string>&, const std::string& = "cpp",
const std::string& = "");
+ std::string getFileName();
std::string getBaseName();
static std::string addQuotes(const std::string&);
diff --git a/cpp/src/Slice/Python.cpp b/cpp/src/Slice/Python.cpp
index d50a84059cd..4a46afd9fdb 100644
--- a/cpp/src/Slice/Python.cpp
+++ b/cpp/src/Slice/Python.cpp
@@ -73,6 +73,100 @@ interruptedCallback(int /*signal*/)
interrupted = true;
}
+void
+createDirectory(const string& dir)
+{
+ IceUtilInternal::structstat st;
+ if(!IceUtilInternal::stat(dir, &st))
+ {
+ if(!(st.st_mode & S_IFDIR))
+ {
+ ostringstream os;
+ os << "failed to create directory '" << dir
+ << "': file already exists and is not a directory";
+ throw FileException(__FILE__, __LINE__, os.str());
+ }
+ return;
+ }
+
+ if(IceUtilInternal::mkdir(dir, 0777) != 0)
+ {
+ ostringstream os;
+ os << "cannot create directory '" << dir << "': " << strerror(errno);
+ throw FileException(__FILE__, __LINE__, os.str());
+ }
+}
+
+//
+// Starting in the directory given by output (can be empty for the CWD), create all necessary subdirectories
+// in the path given by pkgdir.
+//
+void
+createPackageDirectory(const string& output, const string& pkgdir)
+{
+ assert(output.empty() || IceUtilInternal::directoryExists(output));
+ assert(!pkgdir.empty());
+
+ vector<string> elements;
+ if(!IceUtilInternal::splitString(pkgdir, "/", elements))
+ {
+ throw FileException(__FILE__, __LINE__, "invalid path in '" + pkgdir + "'");
+ }
+
+ assert(!elements.empty());
+
+ //
+ // Create all necessary subdirectories.
+ //
+ string path = output;
+ for(vector<string>::iterator p = elements.begin(); p != elements.end(); ++p)
+ {
+ if(!path.empty())
+ {
+ path += "/";
+ }
+ path += *p;
+ IceUtilInternal::structstat st;
+ if(IceUtilInternal::stat(path, &st) < 0)
+ {
+ if(IceUtilInternal::mkdir(path, 0777) != 0)
+ {
+ ostringstream os;
+ os << "cannot create directory '" << path << "': " << strerror(errno);
+ throw FileException(__FILE__, __LINE__, os.str());
+ }
+ FileTracker::instance()->addDirectory(path);
+ }
+ else if(!(st.st_mode & S_IFDIR))
+ {
+ ostringstream os;
+ os << "failed to create directory '" << path << "': file already exists and is not a directory";
+ throw FileException(__FILE__, __LINE__, os.str());
+ }
+
+ //
+ // It's possible that the pkgdir metadata specified a directory that won't be visited by our
+ // PackageVisitor. We need every intermediate subdirectory to have an __init__.py file, which
+ // can be empty.
+ //
+ const string init = path + "/__init__.py";
+ if(!IceUtilInternal::fileExists(init))
+ {
+ //
+ // Create an empty file.
+ //
+ IceUtilInternal::Output out;
+ out.open(init.c_str());
+ if(!out)
+ {
+ ostringstream os;
+ os << "cannot open '" << init << "': " << strerror(errno);
+ throw FileException(__FILE__, __LINE__, os.str());
+ }
+ FileTracker::instance()->addFile(init);
+ }
+ }
+}
//
// For each Slice file Foo.ice we generate Foo_ice.py containing the Python
@@ -114,8 +208,6 @@ private:
static const char* _moduleTag;
static const char* _submoduleTag;
- static void createDirectory(const string&);
-
static void addModule(const string&, const string&, const string&);
static void addSubmodule(const string&, const string&, const string&);
@@ -187,32 +279,6 @@ PackageVisitor::visitModuleEnd(const ModulePtr& p)
}
void
-PackageVisitor::createDirectory(const string& dir)
-{
- IceUtilInternal::structstat st;
- if(!IceUtilInternal::stat(dir, &st))
- {
- if(!(st.st_mode & S_IFDIR))
- {
- ostringstream os;
- os << "failed to create package directory `" << dir
- << "': file already exists and is not a directory";
- throw FileException(__FILE__, __LINE__, os.str());
- }
- return;
- }
-
- if(IceUtilInternal::mkdir(dir, 0777) != 0)
- {
- ostringstream os;
- os << "cannot create directory `" << dir << "': " << strerror(errno);
- throw FileException(__FILE__, __LINE__, os.str());
- }
-
- FileTracker::instance()->addDirectory(dir);
-}
-
-void
PackageVisitor::addModule(const string& dir, const string& module, const string& name)
{
//
@@ -256,7 +322,7 @@ PackageVisitor::readInit(const string& dir, StringList& modules, StringList& sub
if(!in)
{
ostringstream os;
- os << "cannot open file `" << initPath << "': " << strerror(errno);
+ os << "cannot open file '" << initPath << "': " << strerror(errno);
throw FileException(__FILE__, __LINE__, os.str());
}
@@ -291,7 +357,7 @@ PackageVisitor::readInit(const string& dir, StringList& modules, StringList& sub
if(s.size() < 8)
{
ostringstream os;
- os << "invalid line `" << s << "' in `" << initPath << "'";
+ os << "invalid line '" << s << "' in '" << initPath << "'";
throw os.str();
}
@@ -323,14 +389,14 @@ PackageVisitor::readInit(const string& dir, StringList& modules, StringList& sub
if(state != InSubmodules)
{
ostringstream os;
- os << "invalid line `" << s << "' in `" << initPath << "'";
+ os << "invalid line '" << s << "' in '" << initPath << "'";
throw os.str();
}
if(s.size() < 15)
{
ostringstream os;
- os << "invalid line `" << s << "' in `" << initPath << "'";
+ os << "invalid line '" << s << "' in '" << initPath << "'";
throw os.str();
}
@@ -338,10 +404,10 @@ PackageVisitor::readInit(const string& dir, StringList& modules, StringList& sub
}
}
- if(state != InSubmodules)
+ if(state == InModules)
{
ostringstream os;
- os << "invalid format in `" << initPath << "'" << endl;
+ os << "invalid format in '" << initPath << "'" << endl;
throw os.str();
}
}
@@ -357,7 +423,7 @@ PackageVisitor::writeInit(const string& dir, const string& name, const StringLis
if(!os)
{
ostringstream os;
- os << "cannot open file `" << initPath << "': " << strerror(errno);
+ os << "cannot open file '" << initPath << "': " << strerror(errno);
throw FileException(__FILE__, __LINE__, os.str());
}
FileTracker::instance()->addFile(initPath);
@@ -521,6 +587,12 @@ Slice::Python::compile(const vector<string>& argv)
return EXIT_FAILURE;
}
+ if(!output.empty() && !IceUtilInternal::directoryExists(output))
+ {
+ consoleErr << argv[0] << ": error: argument for --output-dir does not exist or is not a directory" << endl;
+ return EXIT_FAILURE;
+ }
+
int status = EXIT_SUCCESS;
IceUtil::CtrlCHandler ctrlCHandler;
@@ -627,32 +699,70 @@ Slice::Python::compile(const vector<string>& argv)
}
//
+ // Check if the file contains the python:pkgdir global metadata.
+ //
+ const string pkgdir = getPackageDirectory(icecpp->getFileName(), u);
+
+ //
// If --build-package is specified, we don't generate any code and simply
// update the __init__.py files.
//
if(!buildPackage)
{
+ string path;
+ if(!output.empty())
+ {
+ path = output + '/'; // The output directory must already exist.
+ }
+
+ if(!pkgdir.empty())
+ {
+ //
+ // The metadata is present. It should have the form
+ //
+ // python:pkgdir:A/B/C
+ //
+ // We open the output file in the specified directory, prefixed by the
+ // output directory (if any).
+ //
+ createPackageDirectory(output, pkgdir);
+ path += pkgdir;
+ if(path[path.size() - 1] != '/')
+ {
+ path += "/"; // Append a separator if necessary.
+ }
+ }
+ else
+ {
+ //
+ // The file doesn't contain the python:pkgdir metadata, so we use the
+ // value of the --prefix option (if any).
+ //
+ path += prefix;
+ }
+
+ //
+ // Add the file name (without the .ice extension).
+ //
+ path += base;
+
//
// Append the suffix "_ice" to the filename in order to avoid any conflicts
- // with Slice module names. For example, if the file Test.ice defines a
+ // with Slice module or type names. For example, if the file Test.ice defines a
// Slice module named "Test", then we couldn't create a Python package named
// "Test" and also call the generated file "Test.py".
//
- string file = prefix + base + "_ice.py";
- if(!output.empty())
- {
- file = output + '/' + file;
- }
+ path += "_ice.py";
IceUtilInternal::Output out;
- out.open(file.c_str());
+ out.open(path.c_str());
if(!out)
{
ostringstream os;
- os << "cannot open`" << file << "': " << strerror(errno);
+ os << "cannot open '" << path << "': " << strerror(errno);
throw FileException(__FILE__, __LINE__, os.str());
}
- FileTracker::instance()->addFile(file);
+ FileTracker::instance()->addFile(path);
//
// Emit a Python magic comment to set the file encoding.
@@ -675,7 +785,16 @@ Slice::Python::compile(const vector<string>& argv)
//
if(!noPackage)
{
- PackageVisitor::createModules(u, prefix + base + "_ice", output);
+ string name;
+ if(!pkgdir.empty())
+ {
+ name = getImportFileName(icecpp->getFileName(), u, vector<string>());
+ }
+ else
+ {
+ name = prefix + base + "_ice";
+ }
+ PackageVisitor::createModules(u, name, output);
}
}
catch(const Slice::FileException& ex)
diff --git a/cpp/src/Slice/PythonUtil.cpp b/cpp/src/Slice/PythonUtil.cpp
index ace5a9db9b1..92560601189 100644
--- a/cpp/src/Slice/PythonUtil.cpp
+++ b/cpp/src/Slice/PythonUtil.cpp
@@ -2850,6 +2850,78 @@ Slice::Python::CodeVisitor::writeDocstring(const OperationPtr& op, DocstringMode
_out << nl << "\"\"\"";
}
+string
+Slice::Python::getPackageDirectory(const string& file, const UnitPtr& unit)
+{
+ //
+ // file must be a fully-qualified path name.
+ //
+
+ //
+ // Check if the file contains the python:pkgdir global metadata.
+ //
+ DefinitionContextPtr dc = unit->findDefinitionContext(file);
+ assert(dc);
+ const string prefix = "python:pkgdir:";
+ string pkgdir = dc->findMetaData(prefix);
+ if(!pkgdir.empty())
+ {
+ //
+ // The metadata is present, so the generated file was placed in the specified directory.
+ //
+ pkgdir = pkgdir.substr(prefix.size());
+ assert(!pkgdir.empty()); // This situation should have been caught by MetaDataVisitor.
+ }
+ return pkgdir;
+}
+
+string
+Slice::Python::getImportFileName(const string& file, const UnitPtr& unit, const vector<string>& includePaths)
+{
+ //
+ // The file and includePaths arguments must be fully-qualified path names.
+ //
+
+ //
+ // Check if the file contains the python:pkgdir global metadata.
+ //
+ string pkgdir = getPackageDirectory(file, unit);
+ if(!pkgdir.empty())
+ {
+ //
+ // The metadata is present, so the generated file was placed in the specified directory.
+ //
+ vector<string> names;
+ IceUtilInternal::splitString(pkgdir, "/", names);
+ assert(!names.empty());
+ pkgdir = "";
+ for(vector<string>::iterator p = names.begin(); p != names.end(); ++p)
+ {
+ if(p != names.begin())
+ {
+ pkgdir += ".";
+ }
+ pkgdir += fixIdent(*p);
+ }
+ string::size_type pos = file.rfind('/');
+ assert(pos != string::npos);
+ string name = file.substr(pos + 1); // Get the name of the file without the leading path.
+ assert(!name.empty());
+ replace(name.begin(), name.end(), '.', '_'); // Convert .ice to _ice
+ return pkgdir + "." + name;
+ }
+ else
+ {
+ //
+ // The metadata is not present, so we transform the file name using the include paths (-I)
+ // given to the compiler.
+ //
+ string name = changeInclude(file, includePaths);
+ replace(name.begin(), name.end(), '/', '_');
+ return name + "_ice";
+ }
+}
+
void
Slice::Python::generate(const UnitPtr& un, bool all, bool checksum, const vector<string>& includePaths,
Output& out)
@@ -2871,9 +2943,7 @@ Slice::Python::generate(const UnitPtr& un, bool all, bool checksum, const vector
StringList includes = un->includeFiles();
for(StringList::const_iterator q = includes.begin(); q != includes.end(); ++q)
{
- string file = changeInclude(*q, paths);
- replace(file.begin(), file.end(), '/', '_');
- out << nl << "import " << file << "_ice";
+ out << nl << "import " << getImportFileName(*q, un, paths);
}
}
@@ -3028,6 +3098,11 @@ Slice::Python::MetaDataVisitor::visitUnitStart(const UnitPtr& p)
{
continue;
}
+ static const string pkgdirPrefix = "python:pkgdir:";
+ if(s.find(pkgdirPrefix) == 0 && s.size() > pkgdirPrefix.size())
+ {
+ continue;
+ }
dc->warning(InvalidMetaData, file, "", "ignoring invalid global metadata `" + s + "'");
globalMetaData.remove(s);
diff --git a/cpp/src/Slice/PythonUtil.h b/cpp/src/Slice/PythonUtil.h
index 0b26d696e3b..d0967fce529 100644
--- a/cpp/src/Slice/PythonUtil.h
+++ b/cpp/src/Slice/PythonUtil.h
@@ -19,6 +19,17 @@ namespace Python
{
//
+// Get the package directory from metadata (if any).
+//
+std::string getPackageDirectory(const std::string&, const Slice::UnitPtr&);
+
+//
+// Determine the name of a Python source file for use in an import statement.
+// The return value does not include the .py extension.
+//
+std::string getImportFileName(const std::string&, const Slice::UnitPtr&, const std::vector<std::string>&);
+
+//
// Generate Python code for a translation unit.
//
void generate(const Slice::UnitPtr&, bool, bool, const std::vector<std::string>&, IceUtilInternal::Output&);
generated by cgit v1.2.3 (git 2.46.0) at 2025-08-03 12:53:52 +0000