Fix bug 2186 (from Bo Peng):

[lyx.git] / src / support / filetools.h

diff --git a/src/support/filetools.h b/src/support/filetools.h
index 092aa70a45c3586b8ad3570dc4afc27c05377d4e..7c0262cf2654faf93de72eed8ce4fbc9f24fdb19 100644 (file)
--- a/src/support/filetools.h
+++ b/src/support/filetools.h
@@ -77,12 +77,10 @@ bool IsLyXFilename(std::string const & filename);
 bool IsSGMLFilename(std::string const & filename);
 
 /** Returns the path of a library data file.
-  Search the file name.ext in the subdirectory dir of
-  \begin{enumerate}
-    \item user_lyxdir
-    \item build_lyxdir (if not empty)
-    \item system_lyxdir
-  \end{enumerate}
+    Search the file name.ext in the subdirectory dir of
+      -# user_lyxdir
+      -# build_lyxdir (if not empty)
+      -# system_lyxdir
     The third parameter `ext' is optional.
 */
 std::string const LibFileSearch(std::string const & dir, std::string const & name,
@@ -104,18 +102,38 @@ i18nLibFileSearch(std::string const & dir, std::string const & name,
  */
 std::string const LibScriptSearch(std::string const & command);
 
+enum latex_path_extension {
+       PROTECT_EXTENSION,
+       EXCLUDE_EXTENSION
+};
+
+enum latex_path_dots {
+       LEAVE_DOTS,
+       ESCAPE_DOTS
+};
+
 /** @param path a file path in internal_path format. Ie, directories
  *  are indicated by '/', not by '\'.
  *
  *  Manipulates @c path into a form suitable for inclusion in a LaTeX
- *  document.  
+ *  document.
  *  If @c path contains LaTeX special characters, these are escaped.
- *  Eg, '~' -> '\string~'
+ *  Eg, '~' -> '\\string~'
  *  If @c path contains spaces, then the returned path is enclosed in
  *  "-quotes. This last fix will lead to successful compiliation of the
  *  LaTeX file only if a sufficiently modern LaTeX compiler is used.
+ *  If @c ext == EXCLUDE_EXTENSION the extension is left outside the quotes.
+ *  This is needed for pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
+ *  (format=pdflatex 2005.4.11) in combination with
+ *  pdftex.def 2002/06/19 v0.03k graphics/color for pdftex:
+ *  It does not recognize the file extension if it is inside the quotes.
+ *  If @c dots == ESCAPE_DOTS dots in the filename are replaced by
+ *  "\\lyxdot ". This is needed for the \\includegraphics command if the
+ *  automatic format selection is used.
  */
-std::string const latex_path(std::string const & path);
+std::string const latex_path(std::string const & path,
+               latex_path_extension extension = PROTECT_EXTENSION,
+               latex_path_dots dots = LEAVE_DOTS);
 
 /// Substitutes active latex characters with underscores in filename
 std::string const MakeLatexName(std::string const & file);
@@ -136,6 +154,9 @@ std::string const AddPath(std::string const & path, std::string const & path2);
 std::string const
 ChangeExtension(std::string const & oldname, std::string const & extension);
 
+/// Remove the extension from \p name
+std::string const removeExtension(std::string const & name);
+
 /// Return the extension of the file (not including the .)
 std::string const GetExtension(std::string const & name);