EditorVCSInterface¶
Inherits: Object
Version Control System (VCS) interface, which reads and writes to the local VCS in use.
Description¶
Defines the API that the editor uses to extract information from the underlying VCS. The implementation of this API is included in VCS plugins, which are GDExtension plugins that inherit EditorVCSInterface and are attached (on demand) to the singleton instance of EditorVCSInterface. Instead of performing the task themselves, all the virtual functions listed below are calling the internally overridden functions in the VCS plugins to provide a plug-n-play experience. A custom VCS plugin is supposed to inherit from EditorVCSInterface and override each of these virtual functions.
Tutorials¶
Methods¶
_checkout_branch ( String branch_name ) virtual |
|
void |
|
void |
_create_branch ( String branch_name ) virtual |
void |
_create_remote ( String remote_name, String remote_url ) virtual |
void |
_discard_file ( String file_path ) virtual |
void |
|
_get_branch_list ( ) virtual |
|
_get_current_branch_name ( ) virtual |
|
_get_line_diff ( String file_path, String text ) virtual |
|
_get_modified_files_data ( ) virtual |
|
_get_previous_commits ( int max_commits ) virtual |
|
_get_remotes ( ) virtual |
|
_get_vcs_name ( ) virtual |
|
_initialize ( String project_path ) virtual |
|
void |
|
void |
|
void |
_remove_branch ( String branch_name ) virtual |
void |
_remove_remote ( String remote_name ) virtual |
void |
_set_credentials ( String username, String password, String ssh_public_key_path, String ssh_private_key_path, String ssh_passphrase ) virtual |
_shut_down ( ) virtual |
|
void |
_stage_file ( String file_path ) virtual |
void |
_unstage_file ( String file_path ) virtual |
add_diff_hunks_into_diff_file ( Dictionary diff_file, Dictionary[] diff_hunks ) |
|
add_line_diffs_into_diff_hunk ( Dictionary diff_hunk, Dictionary[] line_diffs ) |
|
create_commit ( String msg, String author, String id, int unix_timestamp, int offset_minutes ) |
|
create_diff_file ( String new_file, String old_file ) |
|