libaegis/project/file.h File Reference
#include <libaegis/fstate.h>
#include <libaegis/project.h>
#include <libaegis/view_path.h>
Go to the source code of this file.
|
Functions |
| fstate_src_ty * | project_file_find (project_ty *pp, string_ty *filename, view_path_ty as_view_path) |
| fstate_src_ty * | project_file_find_by_uuid (project_ty *pp, string_ty *uuid, view_path_ty vp) |
| fstate_src_ty * | project_file_find (project_ty *pp, fstate_src_ty *c_src, view_path_ty as_view_path) |
| fstate_src_ty * | project_file_find (project_ty *pp, cstate_src_ty *c_src, view_path_ty as_view_path) |
| string_ty * | project_file_path (project_ty *pp, string_ty *file_name) |
| string_ty * | project_file_path (project_ty *pp, fstate_src_ty *src) |
| string_ty * | project_file_path (project_ty *pp, cstate_src_ty *src) |
| string_ty * | project_file_path_by_uuid (project_ty *pp, string_ty *src) |
| fstate_src_ty * | project_file_find_fuzzy (project_ty *pp, string_ty *filename, view_path_ty as_view_path) |
| void | project_file_directory_query (project_ty *, string_ty *, struct string_list_ty *, struct string_list_ty *, view_path_ty as_view_path) |
| string_ty * | project_file_directory_conflict (project_ty *, string_ty *) |
| fstate_src_ty * | project_file_new (project_ty *pp, string_ty *fn) |
| void | project_file_remove (project_ty *, string_ty *) |
| fstate_src_ty * | project_file_nth (project_ty *pp, size_t n, view_path_ty as_view_path) |
| void | project_search_path_get (project_ty *, struct string_list_ty *, int) |
| void | project_file_shallow (project_ty *, string_ty *, long) |
| int | project_file_shallow_check (project_ty *, string_ty *) |
| string_ty * | project_file_version_path (project_ty *, fstate_src_ty *, int *) |
Function Documentation
The project_file_find function is used to find the state information of a file within the project, given the corresponding change file's meta-data. It will search the immediate branch, and then any ancestor branches until the file is found.
- Parameters:
-
| pp | The project to search. |
| c_src | The change file meta-data for which the corresponding project file is sought. |
| as_view_path | If this is true, apply viewpath rules to the file (i.e. if it is removed, return a null pointer) if false return first instance found. |
The project_file_find function is used to find the state information of a file within the project, given the corresponding change file's meta-data. It will search the immediate branch, and then any ancestor branches until the file is found.
- Parameters:
-
| pp | The project to search. |
| c_src | The change file meta-data for which the corresponding project file is sought. |
| as_view_path | If this is true, apply viewpath rules to the file (i.e. if it is removed, return a null pointer) if false return first instance found. |
The project_file_find function is used to find the state information of the named file within the project. It will search the immediate branch, and then any ancestor branches until the file is found.
- Parameters:
-
| pp | The project to search. |
| filename | The base-relative name of the file to search for. |
| as_view_path | If this is true, apply viewpath rules to the file (i.e. if it is removed, return a null pointer) if false return first instance found. |
The project_file_find_by_uuid function is used to find the state information of a file within the project, given the file's UUID. It will search the immediate branch, and then any ancestor branches until the file is found.
- Parameters:
-
| pp | The project to search. |
| uuid | The UUID of the file to search for. |
| vp | If this is true, apply viewpath rules to the file (i.e. if it is removed, return a null pointer) if false return first instance found. |
Definition at line 63 of file file.h.
The project_file_find_fuzzy function is used to find the state information for a project file when the project_file_find function fails. It uses fuzzy string matching, which is significantly slower than exact searching, but can provide very useful error messages for users.
- Parameters:
-
| pp | The project to search. |
| filename | The base-relative name of the file to search for. |
| as_view_path | If this is true, apply viewpath rules to the file (i.e. if it is removed, return a null pointer) if false return first instance found. |
Definition at line 191 of file file.h.
The project_file_nth function is used to get the 'n'th file from the list of project files.
- Parameters:
-
| pp | The project to search. |
| n | The file number to obtain (zero based). |
| as_view_path | If this is false, return all files; if true, ignore removed files. |
Definition at line 222 of file file.h.
The project_file_path function is used to obtain the absolute path to the given project file.
- Parameters:
-
| pp | The project in question. |
| src | The file in question. |
- Returns:
- string containing absolute path of file
- Note:
- It is a bug to callthis function for a file which does not exist, or is not a project source file, or is a removed source file.
The project_file_path function is used to obtain the absolute path to the given project file.
- Parameters:
-
| pp | The project in question. |
| src | The file in question. |
- Returns:
- string containing absolute path of file
- Note:
- It is a bug to callthis function for a file which does not exist, or is not a project source file, or is a removed source file.
The project_file_path function is used to obtain the absolute path to the given project file.
- Parameters:
-
| pp | The project in question. |
| file_name | The name of the file in question. |
- Returns:
- string containing absolute path of file
- Note:
- It is a bug to callthis function for a file which does not exist, or is not a project source file, or is a removed source file.
The project_file_path_by_uuid function is used to obtain the absolute path to a project file specified by its UUID.
- Parameters:
-
| pp | The project in question. |
| uuid | The UUID of the file in question. |
- Returns:
- string containing absolute path of file
- Note:
- It is a bug to callthis function for a file which does not exist, or is not a project source file, or is a removed source file.
