2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2001 The LyX Team.
10 * ====================================================== */
22 #include <boost/utility.hpp>
24 /** The latest documents loaded.
25 This class takes care of the last .lyx files used by the LyX user. It
26 both reads and writes this information to a file. The number of files
27 kept are user defined, but defaults to four.
28 @author Lars Gullik Bjønnes
30 class LastFiles : boost::noncopyable {
33 typedef std::deque<string> Files;
36 typedef Files::const_iterator const_iterator;
38 /** Read the lastfiles file.
39 @param file The file to read the lastfiles form.
40 @param dostat Whether to check for file existance.
41 @param num number of files to remember.
44 LastFiles(string const & file,
45 bool dostat = true, unsigned int num = 4);
47 /** Insert #file# into the list.
48 This funtion inserts #file# into the last files list. If the file
49 already exist it is moved to the top of the list, else exist it
50 is placed on the top of the list. If the list is full the last
51 file in the list is popped from the end.
52 @param file the file to insert in the list.
54 void newFile(string const & file);
55 /** Writes the lastfiles table to disk.
56 Writes one file on each line, this way we can at least have
57 some special chars (e.g. space), but newline in filenames
59 @param file the file we write the lastfiles list to.
61 void writeFile(string const & file) const;
62 /** Return file #n# in the lastfiles list.
63 @param n number in the list to get
65 string const operator[](unsigned int n) const;
66 /// Iterator to the beginning of the list.
67 Files::const_iterator begin() const { return files.begin(); }
68 /// Iterator to the end of the list.
69 Files::const_iterator end() const { return files.end(); }
72 It is more portable among different C++ compilers to use
73 an enum instead of #int const XXX#
75 enum local_constants {
76 /// Default number of lastfiles.
78 /** Max number of lastfiles.
79 There is no point in keeping more than this number
80 of files at the same time. However perhaps someday
81 someone finds use for more files and wants to
82 change it. Please do. But don't show the files in
85 ABSOLUTEMAXLASTFILES = 20
88 /// a list of lastfiles
90 /// number of files in the lastfiles list.
91 unsigned int num_files;
92 /// check for file existance or not.
95 /** Read the lastfiles file.
96 Reads the #.lyx_lastfiles# at the beginning of the LyX session.
97 This will read the lastfiles file (usually #.lyx_lastfiles#). It
98 will normally discard files that don't exist anymore, unless
99 LastFiles has been initialized with #dostat = false#.
100 @param file the file containing the lastfiles.
102 void readFile(string const & file);
103 /** Used by the constructor to set the number of stored last files.
104 @param num the number of lastfiles to set.
106 void setNumberOfFiles(unsigned int num);