src/support/Package.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Package.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  *
  11  * A store of the paths to the various different directoies used
  12  * by LyX. These paths differ markedly from one OS to another,
  13  * following the local Windows, MacOS X or Posix conventions.
  14  */
  15
  16 #ifndef PACKAGE_H
  17 #define PACKAGE_H
  18
  19 #include "support/FileName.h"
  20
  21 #include <string>
  22
  23 namespace lyx {
  24 namespace support {
  25
  26 class Package;
  27
  28 /** When run in-place <build-dir>/src/lyx is one level up from
  29  *  the <build-dir> whilst <build-dir>/src/tex2lyx/tex2lyx is
  30  *  two levels up.
  31  */
  32 enum exe_build_dir_to_top_build_dir {
  33         top_build_dir_is_one_level_up,
  34         top_build_dir_is_two_levels_up
  35 };
  36
  37
  38 /** Initialise package() with the command line data.
  39  *  This data is exactly as it was passed in the argv[] array.
  40  *
  41  *  @param command_line_arg0 argv[0], the name of the LyX executable
  42  *  as passed on the command line.
  43  *
  44  *  @param command_line_system_support_dir, the LyX system dir,
  45  *  as specified on the command line with "-sysdir <path to dir>".
  46  *
  47  *  @param command_line_user_support_dir, the LyX user dir,
  48  *  as specified on the command line with "-userdir <path to dir>".
  49  */
  50 void init_package(std::string const & command_line_arg0,
  51                   std::string const & command_line_system_support_dir,
  52                   std::string const & command_line_user_support_dir,
  53                   exe_build_dir_to_top_build_dir);
  54
  55 /** Accessor to the global data.
  56  *  Asserts that init_package() has been called first.
  57  */
  58 Package const & package();
  59
  60 class Package {
  61 public:
  62         /// Default constructor does not lead to the paths being set.
  63         Package() {}
  64
  65         /** Called by init_package, above.
  66          *  All paths will be initialized.
  67          */
  68         Package(std::string const & command_line_arg0,
  69                 std::string const & command_line_system_support_dir,
  70                 std::string const & command_line_user_support_dir,
  71                 exe_build_dir_to_top_build_dir);
  72
  73         /** The directory containing the LyX executable.
  74          */
  75         FileName const & binary_dir() const { return binary_dir_; }
  76
  77         /** The top of the LyX source code tree.
  78          */
  79         static FileName const & top_srcdir();
  80
  81         /** The path to the system-level support files
  82          *  we're actually going to use.
  83          */
  84         FileName const & system_support() const { return system_support_dir_; }
  85
  86         /** The path to the autogenerated support files
  87          *  when running in-place.
  88          */
  89         FileName const & build_support() const { return build_support_dir_; }
  90
  91         /** The path to the user-level support files.
  92          */
  93         FileName const & user_support() const { return user_support_dir_; }
  94
  95         /** The user_support directory was set explicitly using either
  96          *  the -userdir command line switch or
  97          *  the LYX_USERDIR_15x environment variable.
  98          */
  99         bool explicit_user_support() const { return explicit_user_support_dir_; }
 100
 101         /** The path to the locale directory.
 102          */
 103         FileName const & locale_dir() const { return locale_dir_; }
 104
 105         /** The default document directory.
 106          *  Can be reset by LyXRC.
 107          */
 108         FileName & document_dir() const { return document_dir_; }
 109
 110         /** The path to the system temporary directory.
 111          *  (Eg /tmp on *nix.)
 112          */
 113         FileName const & system_temp_dir() const { return system_temp_dir_; }
 114
 115         /** The path to the temporary directory used by LyX.
 116          *  (Eg /tmp/lyx_tmpdir800nBI1z9 on *nix.)
 117          *  Can be reset by LyXRC.
 118          */
 119         FileName & temp_dir() const { return temp_dir_; }
 120
 121         /** Used when setting the user_support directory.
 122          *  Used also when expanding "~/" or contracting to "~/". (filetools.cpp)
 123          *  Used in emergencyWrite (BufferList.cpp) as one possible location
 124          *  for the dump.
 125          *  This may be empty (e. g. when run under a CGI environment)
 126          */
 127         FileName const & home_dir() const { return home_dir_; }
 128
 129         /** Command to run the configure script.
 130          *  Caution: This is "ready-to-run", i.e. in the locale encoding, not
 131          *  utf8.
 132          */
 133         std::string const & configure_command() const { return configure_command_; }
 134
 135 private:
 136         FileName binary_dir_;
 137         FileName system_support_dir_;
 138         FileName build_support_dir_;
 139         FileName user_support_dir_;
 140         FileName locale_dir_;
 141         mutable FileName document_dir_;
 142         mutable FileName temp_dir_;
 143         FileName system_temp_dir_;
 144         FileName home_dir_;
 145         std::string configure_command_;
 146         bool explicit_user_support_dir_;
 147 };
 148
 149 } // namespace support
 150 } // namespace lyx
 151
 152 #endif // PACKAGE_H