mirror of
https://github.com/textmate/textmate.git
synced 2026-04-28 03:00:34 -04:00
Change document_t to be a thin wrapper for OakDocument
This commit is contained in:
Allan Odgaard
@@ -5,7 +5,6 @@
|
||||
#include <undo/undo.h>
|
||||
#include <plist/uuid.h>
|
||||
#include <plist/date.h>
|
||||
#include <settings/settings.h>
|
||||
#include <text/types.h>
|
||||
#include <authorization/authorization.h>
|
||||
#include <file/bytes.h>
|
||||
@@ -15,14 +14,21 @@
|
||||
#include <scope/scope.h>
|
||||
#include <regexp/glob.h>
|
||||
#include <oak/debug.h>
|
||||
#include <objc/objc.h>
|
||||
|
||||
#ifdef __OBJC__
|
||||
@class OakDocument;
|
||||
@class OakDocumentObserver;
|
||||
#else
|
||||
typedef struct objc_object OakDocument;
|
||||
typedef struct objc_object OakDocumentObserver;
|
||||
#endif
|
||||
|
||||
namespace document
|
||||
{
|
||||
PUBLIC extern std::string const kBookmarkIdentifier;
|
||||
|
||||
struct watch_t;
|
||||
struct document_t;
|
||||
typedef std::shared_ptr<watch_t> watch_ptr;
|
||||
typedef std::shared_ptr<document_t> document_ptr;
|
||||
typedef std::weak_ptr<document_t> document_weak_ptr;
|
||||
|
||||
@@ -66,55 +72,93 @@ namespace document
|
||||
{
|
||||
WATCH_LEAKS(document_t);
|
||||
|
||||
document_t () : _selection(NULL_STR), _folded(NULL_STR), _revision(0), _disk_revision(0), _modified(false), _path(NULL_STR), _open_count(0), _is_on_disk(false), _recent_tracking(true), _backup_path(NULL_STR), _backup_revision(0), _virtual_path(NULL_STR), _custom_name(NULL_STR), _untitled_count(0), _file_type(NULL_STR), /*_folder(NULL_STR),*/ _disk_encoding(NULL_STR), _disk_newlines(NULL_STR) { }
|
||||
document_t (OakDocument* document);
|
||||
~document_t ();
|
||||
|
||||
bool operator== (document_t const& rhs) const { return _identifier == rhs._identifier; }
|
||||
bool operator!= (document_t const& rhs) const { return _identifier != rhs._identifier; }
|
||||
bool operator== (document_t const& rhs) const { return this == &rhs || identifier() == rhs.identifier(); }
|
||||
bool operator!= (document_t const& rhs) const { return this != &rhs && identifier() != rhs.identifier(); }
|
||||
|
||||
// ============================================================
|
||||
// = Doing one-pass reading of file (find in arbitrary files) =
|
||||
// ============================================================
|
||||
// Only in document_t
|
||||
bool sticky () const { return _sticky; }
|
||||
void set_sticky (bool flag) { _sticky = flag; }
|
||||
|
||||
void sync_open (CFStringRef runLoopMode = kCFRunLoopDefaultMode);
|
||||
bool sync_save (CFStringRef runLoopMode = kCFRunLoopDefaultMode);
|
||||
|
||||
void show ();
|
||||
void hide ();
|
||||
oak::date_t lru () const;
|
||||
|
||||
// ===================
|
||||
// = Simple Wrappers =
|
||||
// ===================
|
||||
|
||||
oak::uuid_t identifier () const;
|
||||
std::string path () const;
|
||||
std::string virtual_path () const;
|
||||
std::string custom_name () const;
|
||||
std::string backup_path () const;
|
||||
std::string display_name () const;
|
||||
encoding::type disk_encoding () const;
|
||||
std::string file_type () const;
|
||||
ssize_t revision () const;
|
||||
std::string content () const;
|
||||
bool is_open () const;
|
||||
bool is_modified () const;
|
||||
bool is_on_disk () const;
|
||||
text::indent_t indent () const;
|
||||
bool recent_tracking () const;
|
||||
std::string selection () const;
|
||||
std::string folded () const;
|
||||
ng::index_t visible_index () const;
|
||||
|
||||
void set_path (std::string const& newPath);
|
||||
void set_authorization (osx::authorization_t const& auth);
|
||||
void set_virtual_path (std::string const& virtualPath);
|
||||
void set_custom_name (std::string const& newCustomName);
|
||||
void set_file_type (std::string const& newFileType);
|
||||
void set_revision (ssize_t rev);
|
||||
void set_content (std::string const& str);
|
||||
void set_disk_revision (ssize_t rev);
|
||||
void set_disk_encoding (encoding::type const& encoding);
|
||||
void set_indent (text::indent_t const& indent);
|
||||
void set_recent_tracking (bool flag);
|
||||
void set_selection (std::string const& sel);
|
||||
void set_folded (std::string const& folded);
|
||||
void set_visible_index (ng::index_t index);
|
||||
|
||||
ng::buffer_t& buffer ();
|
||||
ng::undo_manager_t& undo_manager ();
|
||||
|
||||
// ===========
|
||||
// = Methods =
|
||||
// ===========
|
||||
|
||||
std::map<std::string, std::string> document_variables () const;
|
||||
|
||||
bool backup ();
|
||||
void detach_backup ();
|
||||
|
||||
void enumerate_bytes_using_block (void(^block)(char const* bytes, size_t len, bool* stop));
|
||||
|
||||
// ======================================================
|
||||
// = Performing replacements (from outside a text view) =
|
||||
// ======================================================
|
||||
|
||||
std::map<text::pos_t, std::string> symbols ();
|
||||
bool replace (std::multimap<std::pair<size_t, size_t>, std::string> const& replacements, uint32_t crc32);
|
||||
|
||||
// ===================================================================
|
||||
// = Controlling marks (bookmarks, warnings, errors, search matches) =
|
||||
// ===================================================================
|
||||
bool try_open (document::open_callback_ptr callback);
|
||||
void try_save (document::save_callback_ptr callback);
|
||||
void close ();
|
||||
|
||||
// ===================
|
||||
|
||||
void add_mark (text::pos_t const& pos, std::string const& mark, std::string const& value = std::string());
|
||||
void remove_mark (text::pos_t const& pos, std::string const& mark);
|
||||
void remove_all_marks (std::string const& typeToClear = NULL_STR);
|
||||
|
||||
private:
|
||||
static void setup_marks (std::string const& src, ng::buffer_t& buf);
|
||||
std::string bookmarks_as_string () const;
|
||||
|
||||
std::string _selection;
|
||||
std::string _folded;
|
||||
ng::index_t _visible_index;
|
||||
io::bytes_ptr _content;
|
||||
|
||||
// ===============
|
||||
// = Symbol list =
|
||||
// ===============
|
||||
public:
|
||||
std::map<text::pos_t, std::string> symbols ();
|
||||
|
||||
// ===================
|
||||
// = Callback system =
|
||||
// ===================
|
||||
|
||||
struct callback_t
|
||||
{
|
||||
WATCH_LEAKS(document_t::callback_t);
|
||||
|
||||
enum event_t
|
||||
{
|
||||
did_save,
|
||||
@@ -125,9 +169,7 @@ namespace document
|
||||
did_change_path,
|
||||
did_change_file_type,
|
||||
did_change_indent_settings,
|
||||
// did_change_display_name,
|
||||
did_change_marks,
|
||||
// did_change_symbols,
|
||||
did_change_content,
|
||||
};
|
||||
|
||||
@@ -136,189 +178,21 @@ namespace document
|
||||
virtual void document_will_delete (document_t* document) { }
|
||||
};
|
||||
|
||||
void add_callback (callback_t* callback) { _callbacks.add(callback); }
|
||||
void remove_callback (callback_t* callback) { _callbacks.remove(callback); }
|
||||
void add_callback (callback_t* callback);
|
||||
void remove_callback (callback_t* callback);
|
||||
|
||||
private:
|
||||
void check_modified (ssize_t diskRev, ssize_t rev);
|
||||
// ==========
|
||||
// = Legacy =
|
||||
// ==========
|
||||
|
||||
void broadcast (callback_t::event_t event)
|
||||
{
|
||||
_callbacks(&callback_t::handle_document_event, shared_from_this(), event);
|
||||
}
|
||||
|
||||
oak::callbacks_t<callback_t> _callbacks;
|
||||
|
||||
// ===================
|
||||
// = For OakTextView =
|
||||
// ===================
|
||||
|
||||
void post_load (std::string const& path, io::bytes_ptr content, std::map<std::string, std::string> const& attributes, std::string const& fileType, encoding::type const& encoding);
|
||||
|
||||
struct open_callback_wrapper_t : file::open_callback_t
|
||||
{
|
||||
open_callback_wrapper_t (document::document_ptr doc, document::open_callback_ptr callback) : _document(doc), _callbacks(1, callback) { }
|
||||
|
||||
void select_charset (std::string const& path, io::bytes_ptr content, file::open_context_ptr context) { _callbacks[0]->select_charset(path, content, context); }
|
||||
void select_line_feeds (std::string const& path, io::bytes_ptr content, file::open_context_ptr context) { _callbacks[0]->select_line_feeds(path, content, context); }
|
||||
void select_file_type (std::string const& path, io::bytes_ptr content, file::open_context_ptr context) { if(_document->file_type() == NULL_STR) _callbacks[0]->select_file_type(path, content, context); else context->set_file_type(_document->file_type()); }
|
||||
void add_callback (document::open_callback_ptr callback) { _callbacks.push_back(callback); }
|
||||
|
||||
void show_content (std::string const& path, io::bytes_ptr content, std::map<std::string, std::string> const& attributes, std::string const& fileType, encoding::type const& encoding, std::vector<oak::uuid_t> const& binaryImportFilters, std::vector<oak::uuid_t> const& textImportFilters)
|
||||
{
|
||||
// we are deleted in post_load() so make a copy of relevant data
|
||||
std::vector<document::open_callback_ptr> callbacks(_callbacks);
|
||||
document::document_ptr doc = _document;
|
||||
|
||||
_document->post_load(path, content, attributes, fileType, encoding);
|
||||
for(auto const& cb : callbacks)
|
||||
cb->show_document(path, doc);
|
||||
}
|
||||
|
||||
void show_error (std::string const& path, std::string const& message, oak::uuid_t const& filter)
|
||||
{
|
||||
// we are deleted in post_load() so make a copy of relevant data
|
||||
std::vector<document::open_callback_ptr> callbacks(_callbacks);
|
||||
document::document_ptr doc = _document;
|
||||
|
||||
_document->post_load(path, io::bytes_ptr(), std::map<std::string, std::string>(), NULL_STR, encoding::type());
|
||||
for(auto const& cb : callbacks)
|
||||
cb->show_error(path, doc, message, filter);
|
||||
}
|
||||
|
||||
private:
|
||||
document::document_ptr _document;
|
||||
std::vector<document::open_callback_ptr> _callbacks;
|
||||
};
|
||||
|
||||
typedef std::shared_ptr<open_callback_wrapper_t> open_callback_wrapper_ptr;
|
||||
open_callback_wrapper_ptr _open_callback;
|
||||
|
||||
void post_save (std::string const& path, io::bytes_ptr content, encoding::type const& encoding, bool succes);
|
||||
|
||||
public:
|
||||
bool try_open (document::open_callback_ptr callback);
|
||||
void sync_open (CFStringRef runLoopMode = kCFRunLoopDefaultMode);
|
||||
void close ();
|
||||
|
||||
void show ();
|
||||
void hide ();
|
||||
oak::date_t lru () const;
|
||||
|
||||
void try_save (document::save_callback_ptr callback);
|
||||
bool sync_save (CFStringRef runLoopMode = kCFRunLoopDefaultMode);
|
||||
bool backup ();
|
||||
void detach_backup () { _backup_path = NULL_STR; }
|
||||
|
||||
void set_path (std::string const& newPath);
|
||||
void set_virtual_path (std::string const& virtualPath) { _virtual_path = virtualPath; }
|
||||
void set_custom_name (std::string const& newCustomName) { _custom_name = newCustomName; }
|
||||
void set_file_type (std::string const& newFileType);
|
||||
|
||||
std::string path () const { return _path; }
|
||||
std::string virtual_path () const { return _virtual_path == NULL_STR ? _path : _virtual_path; }
|
||||
std::string custom_name () const { return _custom_name; }
|
||||
std::string backup_path () const;
|
||||
std::string display_name () const;
|
||||
|
||||
void set_disk_encoding (encoding::type const& encoding) { _disk_newlines = encoding.newlines(); _disk_encoding = encoding.charset(); }
|
||||
encoding::type disk_encoding () const { return encoding::type(_disk_newlines, _disk_encoding); }
|
||||
|
||||
void set_indent (text::indent_t const& indent);
|
||||
text::indent_t const& indent () const;
|
||||
|
||||
bool recent_tracking () const { return _recent_tracking && _path != NULL_STR; }
|
||||
void set_recent_tracking (bool flag) { _recent_tracking = flag; }
|
||||
|
||||
bool sticky () const { return _sticky; }
|
||||
void set_sticky (bool flag) { _sticky = flag; }
|
||||
|
||||
ng::buffer_t& buffer () { ASSERT(_buffer); return *_buffer; }
|
||||
ng::undo_manager_t& undo_manager () { ASSERT(_undo_manager); return *_undo_manager; }
|
||||
|
||||
std::string content () const;
|
||||
void set_content (std::string const& str);
|
||||
|
||||
// =============
|
||||
// = Accessors =
|
||||
// =============
|
||||
|
||||
oak::uuid_t identifier () const { return _identifier; }
|
||||
ssize_t revision () const { return _revision; }
|
||||
void set_revision (ssize_t rev) { check_modified(_disk_revision, rev); }
|
||||
bool is_open () const { return _open_count != 0 && !_open_callback; }
|
||||
|
||||
std::string file_type () const;
|
||||
|
||||
std::map<std::string, std::string> document_variables () const;
|
||||
|
||||
bool is_modified () const;
|
||||
bool is_on_disk () const { return is_open() ? _is_on_disk : path::exists(path()); }
|
||||
void set_disk_revision (ssize_t rev) { check_modified(rev, _revision); }
|
||||
std::string const& selection () const { return _selection; }
|
||||
std::string const& folded () const { return _folded; }
|
||||
ng::index_t visible_index () const { return _visible_index; }
|
||||
|
||||
void set_selection (std::string const& sel) { _selection = sel; _visible_index = ng::index_t(); }
|
||||
void set_folded (std::string const& folded) { _folded = folded; }
|
||||
void set_visible_index (ng::index_t index) { _visible_index = index; }
|
||||
|
||||
void set_authorization (osx::authorization_t const& auth) { _authorization = auth; }
|
||||
|
||||
private:
|
||||
void setup_buffer ();
|
||||
void set_modified (bool flag);
|
||||
|
||||
// ==============
|
||||
// = Properties =
|
||||
// ==============
|
||||
|
||||
friend document_ptr create (std::string const& path);
|
||||
friend document_ptr from_content (std::string const& content, std::string fileType);
|
||||
friend document_ptr find (oak::uuid_t const& uuid);
|
||||
|
||||
oak::uuid_t _identifier; // to identify this document when there is no path
|
||||
inode_t _inode;
|
||||
ssize_t _revision;
|
||||
ssize_t _disk_revision;
|
||||
bool _modified;
|
||||
|
||||
std::string _path; // does not imply there actually is a file
|
||||
size_t _open_count; // document open in some window/tab
|
||||
bool _is_on_disk;
|
||||
bool _recent_tracking;
|
||||
private:
|
||||
OakDocument* _document;
|
||||
OakDocumentObserver* _observer;
|
||||
bool _sticky = false;
|
||||
|
||||
mutable std::string _backup_path; // if there is a backup, this is set — we can have a backup even when there is no path
|
||||
mutable ssize_t _backup_revision;
|
||||
|
||||
std::string _virtual_path;
|
||||
std::string _custom_name;
|
||||
mutable size_t _untitled_count; // this is ≠ 0 if the document is untitled
|
||||
|
||||
mutable std::string _file_type; // this may also be in the settings
|
||||
// oak::uuid_t _grammar_uuid;
|
||||
|
||||
std::shared_ptr<ng::buffer_t> _buffer;
|
||||
std::string _pristine_buffer = NULL_STR;
|
||||
std::shared_ptr<ng::undo_manager_t> _undo_manager;
|
||||
void mark_pristine ();
|
||||
|
||||
// std::string _folder; // when there is no path, this value is where the document will likely end up, i.e, used for retrieving settings and default save location
|
||||
osx::authorization_t _authorization; // when opened via sudo
|
||||
|
||||
friend struct document_tracker_t;
|
||||
size_t untitled_count () const { return _untitled_count; }
|
||||
|
||||
std::string _disk_encoding;
|
||||
std::string _disk_newlines;
|
||||
|
||||
text::indent_t _indent;
|
||||
|
||||
protected: // so that we can trigger the callback in unit tests
|
||||
watch_ptr _file_watcher;
|
||||
friend struct watch_t;
|
||||
void watch_callback (int flags, std::string const& newPath, bool async = true);
|
||||
OakDocumentObserver* observer ();
|
||||
};
|
||||
|
||||
PUBLIC document_ptr create (std::string const& path = NULL_STR);
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,76 +0,0 @@
|
||||
#include <document/document.h>
|
||||
#include <test/jail.h>
|
||||
|
||||
struct helper_t : document::document_t
|
||||
{
|
||||
using document::document_t::watch_callback;
|
||||
};
|
||||
|
||||
static void notify (document::document_ptr doc, int flags, std::string const& path = NULL_STR)
|
||||
{
|
||||
((*doc).*(&helper_t::watch_callback))(flags, path, false);
|
||||
}
|
||||
|
||||
static std::string content (document::document_ptr doc)
|
||||
{
|
||||
return doc->content();
|
||||
}
|
||||
|
||||
void test_file_watch ()
|
||||
{
|
||||
test::jail_t jail;
|
||||
jail.set_content("file.txt", "Hello\n");
|
||||
|
||||
document::document_ptr doc = document::create(jail.path("file.txt"));
|
||||
doc->sync_open();
|
||||
|
||||
jail.set_content("file.txt", "Hello\nworld\n");
|
||||
notify(doc, NOTE_WRITE);
|
||||
OAK_ASSERT_EQ(content(doc), "Hello\nworld\n");
|
||||
|
||||
doc->buffer().insert(5, ", ");
|
||||
doc->set_revision(doc->buffer().bump_revision());
|
||||
OAK_ASSERT_EQ(doc->is_modified(), true);
|
||||
jail.set_content("file.txt", "Hello, \nworld\n");
|
||||
notify(doc, NOTE_WRITE);
|
||||
OAK_ASSERT_EQ(content(doc), "Hello, \nworld\n");
|
||||
OAK_ASSERT_EQ(doc->is_modified(), false);
|
||||
|
||||
jail.set_content("file.txt", "Hello\n");
|
||||
notify(doc, NOTE_WRITE);
|
||||
OAK_ASSERT_EQ(content(doc), "Hello\n");
|
||||
OAK_ASSERT_EQ(doc->is_modified(), false);
|
||||
|
||||
doc->close();
|
||||
}
|
||||
|
||||
void test_merge ()
|
||||
{
|
||||
std::string const original = "Hello\n--\n";
|
||||
std::string const buffer = "Hello, world\n--\n";
|
||||
std::string const disk = "Hello\n--\nworld\n";
|
||||
std::string const merged = "Hello, world\n--\nworld\n";
|
||||
|
||||
test::jail_t jail;
|
||||
jail.set_content("file.txt", original);
|
||||
|
||||
document::document_ptr doc = document::create(jail.path("file.txt"));
|
||||
doc->sync_open();
|
||||
|
||||
doc->set_content(buffer);
|
||||
doc->set_revision(doc->buffer().bump_revision());
|
||||
OAK_ASSERT_EQ(content(doc), buffer);
|
||||
OAK_ASSERT_EQ(doc->is_modified(), true);
|
||||
|
||||
jail.set_content("file.txt", disk);
|
||||
notify(doc, NOTE_WRITE);
|
||||
OAK_ASSERT_EQ(content(doc), merged);
|
||||
OAK_ASSERT_EQ(doc->is_modified(), true);
|
||||
|
||||
jail.set_content("file.txt", merged);
|
||||
notify(doc, NOTE_WRITE);
|
||||
OAK_ASSERT_EQ(content(doc), merged);
|
||||
OAK_ASSERT_EQ(doc->is_modified(), false);
|
||||
|
||||
doc->close();
|
||||
}
|
||||
Reference in New Issue
Block a user