Commit Graph

72 Commits

Author SHA1 Message Date
Orgad Shaneh
a05e54f00c JANITORIAL: Remove trailing whitespaces 2021-05-04 11:46:30 +03:00
Eugene Sandulenko
5e7fe2dc57
JANITORIAL: Replace spaces in indentation with tabs 2021-04-15 21:20:36 +02:00
Bartosz Gentkowski
3ff21ad8c2 DOXYGEN: Further doc updates in high priority files
Adding, editing, updating doxygen comments in header files:

- common/archive.h
- common/array.h
- common/config-manager.h
- common/list.h
- common/random.h
- common/rect.h
- common/savefile.h
2020-11-07 18:19:09 +00:00
Bartosz Gentkowski
ec24687ce4 DOXYGEN: Add doxygen groups to header files in the common folder
Adding @defgroup and @ingroup doxygen tags into all headers
in the common folder that contain doxygen blocks.

This improves the structure, readability, and findability
of information in the resulting output.

This commit targets purely structure and does not deal with
the content of the currently existing doxygen documentation.
2020-10-04 18:25:50 +02:00
sluicebox
baea8d5c9c COMMON: Make save compression optional when copying
Allows for copying or renaming uncompressed save files, such as
in Phantasmagoria 1, without compressing them in the process.
2019-12-09 22:57:46 -08:00
Bastien Bouclet
26d0935b9f COMMON: Remove usage of ScopedPtr in OutSaveFile
It's not very useful. However this is mostly to test the theory that the
build failure we've been experiencing in
engines/scumm/he/logic/football.cpp with the osx builder on buildbot is
related to the size of the intermediary assembly source file.
2019-01-05 12:02:19 +01:00
Alexander Tkachev
368f664c81 COMMON: Fix WriteStream::pos() once again
MemoryReadWriteStream now returns int32, not uint32. It actually doesn't
ever return -1 to indicate that an error occured, so uint32 was a better
choice, but that's what is used in WriteStream base class now.

That method is abstract, so that's also why OutSaveFile had to override
it.
2016-08-24 16:24:16 +06:00
Alexander Tkachev
aee713141b CLOUD: Make OutSaveFile start saves sync
It had to become a proxy class in order to do that.
finalize() starts the saves sync.
2016-08-24 16:07:55 +06:00
Alexander Tkachev
9eb4aad7fd CLOUD: Make DefaultSaveFileManager ignore syncing files
MetaEngines don't get "locked" files in the list, so won't try to open
these.

Save/Load dialog updates save list every time SavesSyncRequest tells it
to.
2016-08-24 16:07:55 +06:00
Alexander Tkachev
cc4512e50b COMMON: Add SaveFileManager::openRawFile()
It's needed for the cloud saves upload/sync feature.
2016-08-24 16:07:55 +06:00
Johannes Schickel
8c5931bca4 COMMON: Add documentation about savefile names. 2016-02-25 21:51:53 +01:00
Johannes Schickel
e7e7aa0558 COMMON: Beautify SaveFileManager documentation. 2016-02-25 21:51:53 +01:00
Johannes Schickel
854e22b38b COMMON: Make GPL headers consistent in themselves. 2014-02-18 02:39:33 +01:00
Johannes Schickel
89abab97e3 JANITORIAL: Remove trailing whitespaces.
Powered by:
git ls-files "*.cpp" "*.h" "*.m" "*.mm" | xargs sed -i -e 's/[ \t]*$//'
2012-09-26 04:17:55 +02:00
Filippos Karapetis
16adcb5145 COMMON: Simplify the documentation in openForSaving()
The new more concise description is courtesy of wjp.
2012-06-25 22:32:00 +03:00
Filippos Karapetis
c9ace6426e COMMON: Add a detailed explanation on when to create uncompressed saves 2012-06-21 10:48:06 +03:00
Filippos Karapetis
4c4a127ca2 COMMON: Add documentation regarding the new parameter in openForSaving() 2012-06-21 10:48:04 +03:00
Filippos Karapetis
e10e412bba COMMON: Allow the savefile manager to create uncompressed saves
These are useful in cases where the files can be used in the original
interpreters (such as the exported characters from QFG), in order to avoid
confusion in cases where the users are unaware that these saves are
compressed and are trying to load them in the original interpreters.
2012-06-21 10:48:03 +03:00
Max Horn
39076ef972 BUILD: Rename UNIX #define to POSIX 2011-05-25 13:23:03 +02:00
strangerke
69b1485a22 GIT: Clean up: Suppress SVN tags, now useless 2011-05-12 01:16:22 +02:00
Littleboy
5a1874e3d9 COMMON: Add SaveFileManager::copySavefile() and update SaveFileManager::renameSavefile() to use it 2011-03-24 18:51:58 -04:00
Max Horn
651e2760a3 Fix spelling, cleanup
svn-id: r49843
2010-06-15 12:33:20 +00:00
Max Horn
c934642bdb COMMON: Move typedef StringList from str.h to new header str-array.h
This removes the dependency on array.h from str.h.
Also, begun migration from the confusing type name "StringList" to
the more appropriate StringArray.

svn-id: r48282
2010-03-18 15:09:24 +00:00
Max Horn
fb79b18571 Changed SaveFileManager methods to take Common::String params (instead of char pointers)
svn-id: r41000
2009-05-29 14:38:22 +00:00
Max Horn
4c8f221fb8 Merged SFMError into Common::Error, added some new error codes; revised some error handling in DefaultSaveManager
svn-id: r34915
2008-11-06 16:40:00 +00:00
Max Horn
38a4eaa001 cleanup
svn-id: r34910
2008-11-06 14:03:38 +00:00
Max Horn
5f4c9f913f Turned InSaveFile & OutSaveFile into simple typedefs
svn-id: r33606
2008-08-04 11:38:25 +00:00
Max Horn
99f546caad Moved the OutSaveFile::finalize method to WriteStream; implemented DumpFile::flush()
svn-id: r33604
2008-08-04 11:30:47 +00:00
Max Horn
28158c80b8 Some corrections to the SaveFileManager Doxygen comments
svn-id: r30913
2008-02-22 00:22:31 +00:00
Jordi Vilalta Prat
66e9d4f5e8 Removed trailing spaces.
svn-id: r30664
2008-01-27 19:47:41 +00:00
Max Horn
9f611ae66d Clarify SaveFileManager::listSavefiles usage
svn-id: r30077
2007-12-30 00:00:03 +00:00
Eugene Sandulenko
d4d072fe04 Patch #1857121: Refactoring of the getSavePath method
svn-id: r30032
2007-12-28 07:37:04 +00:00
Max Horn
15469b47b5 SaveFileManager::setError is an internal method; also, pass string to it by-ref not by-value
svn-id: r29967
2007-12-23 18:12:03 +00:00
Max Horn
3598192859 Patch #1825132: SAVEFILEMAN: renameSavefile implementation
svn-id: r29433
2007-11-06 10:52:47 +00:00
Nicola Mettifogo
258901bab9 Merged common/stdafx.h into common/scummsys.h. All referencing files have been updated.
svn-id: r28966
2007-09-19 08:40:12 +00:00
Max Horn
c3d3aebe87 Patch #1768757: Merge fsnode-gsoc into trunk (MAJOR change, will break compilation on some ports)
svn-id: r28944
2007-09-18 20:02:04 +00:00
David Corrales
9752c75f40 Add a removeSavefile() to the default savefile manager based on the new Common::File::remove().
svn-id: r28282
2007-07-29 01:36:59 +00:00
David Corrales
21f352b2df Added error codes to the SaveFileManager via the SFMError enum. Also, solved TODO's in the default-saves implementation.
svn-id: r28140
2007-07-18 20:51:26 +00:00
David Corrales
720c974faf Changed SaveFileManager::listSavegames() function to be engine agnostic. It now returns a list will the full paths of existing files that match a given regex.
Additionally, modified the 5 engines which use the default manager (Agos, Queen, Saga, Scumm and Touche) to parse the filename list and mark the available saves bool array correctly.

svn-id: r28046
2007-07-12 17:58:15 +00:00
David Corrales
9bfe5d5354 Merged the FSNode branch with trunk r27681:27969
svn-id: r27970
2007-07-08 16:58:54 +00:00
Max Horn
218e132e37 Updated legal headers in source files, based on what Pidgin (the IM client formerly knowns as Gaim) does; added new (incomplete) COPYRIGHT file; updated copyright dates in a few spots
svn-id: r27024
2007-05-30 21:56:52 +00:00
Max Horn
9751421434 Added class NonCopyable, and made various things derive from it
svn-id: r26163
2007-03-17 10:36:14 +00:00
Max Horn
e326f482c9 Get rid of Common::SaveFile
svn-id: r25666
2007-02-17 22:11:00 +00:00
Max Horn
b8aeefaffb Added finalize() method to Common::OutSaveFile (which by default just flushes the stream), changed engines to call that before deleting OutSaveFile instances (instead of just flushing)
svn-id: r25660
2007-02-17 18:55:51 +00:00
Max Horn
d67f9623cc Typo, and stress that getSavePath() is not to be used for storing savegames via Common::File
svn-id: r23286
2006-06-24 10:46:47 +00:00
Max Horn
6a588f8399 Moved savefile code to new 'saves' backend module (work in progress)
svn-id: r23282
2006-06-24 10:08:43 +00:00
Max Horn
0aaa04899c Changed InSaveFile (part of the save file system) to inherit from SeekableReadStream, meaning that savegames opened for reading now are seekable (DC, PS2, Palm ports will have to be updated accordingly)
svn-id: r22180
2006-04-26 11:15:13 +00:00
Max Horn
36934b611d Change CVS keywords to SVN keywords
svn-id: r20510
2006-02-11 09:53:53 +00:00
Eugene Sandulenko
ea42bad781 Update copyright notice
svn-id: r20088
2006-01-18 17:39:49 +00:00
Eugene Sandulenko
b36677af71 Update FSF address. Eek. Actually that took place on May 1, 2005
svn-id: r19142
2005-10-18 01:30:26 +00:00