/*! \brief Asks for confirmation before closing a changed page.
* \par Function Description
* This function asks the user to confirm its closing order for
* page <B>page</B> while it still has unsaved changes.
*
* It displays a message dialog inviting the user to cancel the
* closing, or to discard the changes or to save the changes to a
* file.
*
* \param [in] w_current The toplevel environment.
* \param [in] page The page to close.
*
* \return TRUE if okay to continue with closing page, FALSE
* otherwise.
*/
gboolean
x_dialog_close_changed_page (GschemToplevel *w_current, PAGE *page)
{
GtkWidget *dialog;
PAGE *keep_page;
gboolean result = FALSE;
g_return_val_if_fail (page != NULL && page->CHANGED, TRUE);
keep_page = w_current->toplevel->page_current;
dialog = GTK_WIDGET (g_object_new (TYPE_CLOSE_CONFIRMATION_DIALOG,
"unsaved-page", page,
NULL));
/* set default response signal. This is usually triggered by the
"Return" key */
gtk_dialog_set_default_response(GTK_DIALOG(dialog),
GTK_RESPONSE_YES);
switch (gtk_dialog_run (GTK_DIALOG (dialog))) {
case GTK_RESPONSE_NO:
/* action selected: close without saving */
/* close the page, discard changes */
result = TRUE;
break;
case GTK_RESPONSE_YES:
/* action selected: save */
s_page_goto (w_current->toplevel, page);
gschem_toplevel_page_changed (w_current);
i_callback_file_save(w_current, 0, NULL);
/* has the page been really saved? */
if (!page->CHANGED) {
result = TRUE;
}
/* no, user has cancelled the save and page has changes */
/* do not close page */
break;
case GTK_RESPONSE_CANCEL:
/* action selected: cancel */
/* fall through */
default:
/* Hit when the user breaks out of the dialog with the escape key
* or otherwise destroys the dialog window without a proper response */
/* nothing to do */
break;
}
gtk_widget_destroy (dialog);
/* Switch back to the page we were on if it wasn't the one being closed */
g_return_val_if_fail (keep_page != NULL, result);
if (keep_page != page) {
s_page_goto (w_current->toplevel, keep_page);
gschem_toplevel_page_changed (w_current);
}
return result;
}
/*! \brief Signal handler for a notify::page signal
*
* \param [in] page_view The GschemPageView signal source
* \param [in] w_current The current gschem toplevel
*/
void
gschem_toplevel_notify_page_callback (GschemPageView *page_view, GParamSpec *pspec, GschemToplevel *w_current)
{
g_return_if_fail (w_current != NULL);
gschem_toplevel_page_changed (w_current);
}
/*! \brief Closes a page.
* \par Function Description
* This function closes the page <B>page</B> of toplevel
* <B>toplevel</B>.
*
* If necessary, the current page of <B>toplevel</B> is changed to
* the next valid page or to a new untitled page.
*
* \param [in] w_current The toplevel environment.
* \param [in] page The page to close.
*/
void
x_window_close_page (GschemToplevel *w_current, PAGE *page)
{
TOPLEVEL *toplevel = gschem_toplevel_get_toplevel (w_current);
PAGE *new_current = NULL;
GList *iter;
g_return_if_fail (toplevel != NULL);
g_return_if_fail (page != NULL);
g_assert (page->pid != -1);
/* If we're closing whilst inside an action, re-wind the
* page contents back to their state before we started */
if (w_current->inside_action) {
i_callback_cancel (w_current, 0, NULL);
}
if (page == toplevel->page_current) {
/* as it will delete current page, select new current page */
/* first look up in page hierarchy */
new_current = s_page_search_by_page_id (toplevel->pages, page->up);
if (new_current == NULL) {
/* no up in hierarchy, choice is prev, next, new page */
iter = g_list_find( geda_list_get_glist( toplevel->pages ), page );
if ( g_list_previous( iter ) ) {
new_current = (PAGE *)g_list_previous( iter )->data;
} else if ( g_list_next( iter ) ) {
new_current = (PAGE *)g_list_next( iter )->data;
} else {
/* need to add a new untitled page */
new_current = NULL;
}
}
/* new_current will be the new current page at the end of the function */
}
s_log_message (page->CHANGED ?
_("Discarding page [%s]\n") : _("Closing [%s]\n"),
page->page_filename);
/* remove page from toplevel list of page and free */
s_page_delete (toplevel, page);
gschem_toplevel_page_changed (w_current);
/* Switch to a different page if we just removed the current */
if (toplevel->page_current == NULL) {
/* Create a new page if there wasn't another to switch to */
if (new_current == NULL) {
new_current = x_window_open_page (w_current, NULL);
}
/* change to new_current and update display */
x_window_set_current_page (w_current, new_current);
}
}
/*! \brief Opens a new page from a file.
* \par Function Description
* This function opens the file whose name is <B>filename</B> in a
* new PAGE of <B>toplevel</B>.
*
* If there is no page for <B>filename</B> in <B>toplevel</B>'s list
* of pages, it creates a new PAGE, loads the file in it and returns
* a pointer on the new page. Otherwise it returns a pointer on the
* existing page.
*
* If the filename passed is NULL, this function creates an empty,
* untitled page. The name of the untitled page is build from
* configuration data ('untitled-name') and a counter for uniqueness.
*
* The opened page becomes the current page of <B>toplevel</B>.
*
* \param [in] w_current The toplevel environment.
* \param [in] filename The name of the file to open or NULL for a blank page.
* \returns A pointer on the new page.
*
* \bug This code should check to make sure any untitled filename
* does not conflict with a file on disk.
*/
PAGE*
x_window_open_page (GschemToplevel *w_current, const gchar *filename)
{
TOPLEVEL *toplevel = gschem_toplevel_get_toplevel (w_current);
GschemPageView *page_view = gschem_toplevel_get_current_page_view (w_current);
PAGE *page;
gchar *fn;
g_return_val_if_fail (toplevel != NULL, NULL);
/* Generate untitled filename if none was specified */
if (filename == NULL) {
gchar *cwd, *tmp, *untitled_name;
EdaConfig *cfg;
cwd = g_get_current_dir ();
cfg = eda_config_get_context_for_path (cwd);
untitled_name = eda_config_get_string (cfg, "gschem", "default-filename", NULL);
tmp = g_strdup_printf ("%s_%d.sch",
untitled_name,
++w_current->num_untitled);
fn = g_build_filename (cwd, tmp, NULL);
g_free (untitled_name);
g_free(cwd);
g_free(tmp);
} else {
fn = g_strdup (filename);
}
/* Return existing page if it is already loaded */
page = s_page_search (toplevel, fn);
if ( page != NULL ) {
g_free(fn);
return page;
}
page = s_page_new (toplevel, fn);
s_page_goto (toplevel, page);
gschem_toplevel_page_changed (w_current);
/* Load from file if necessary, otherwise just print a message */
if (filename != NULL) {
GError *err = NULL;
if (!quiet_mode)
s_log_message (_("Loading schematic [%s]\n"), fn);
if (!f_open (toplevel, page, (gchar *) fn, &err)) {
GtkWidget *dialog;
g_warning ("%s\n", err->message);
dialog = gtk_message_dialog_new_with_markup
(GTK_WINDOW (w_current->main_window),
GTK_DIALOG_DESTROY_WITH_PARENT,
GTK_MESSAGE_ERROR,
GTK_BUTTONS_CLOSE,
_("<b>An error occurred while loading the requested file.</b>\n\nLoading from '%s' failed: %s. The gschem log may contain more information."),
fn, err->message);
gtk_window_set_title (GTK_WINDOW (dialog), _("Failed to load file"));
gtk_dialog_run (GTK_DIALOG (dialog));
gtk_widget_destroy (dialog);
g_error_free (err);
} else {
gtk_recent_manager_add_item (recent_manager, g_filename_to_uri(fn, NULL, NULL));
}
} else {
if (!quiet_mode)
s_log_message (_("New file [%s]\n"),
toplevel->page_current->page_filename);
g_run_hook_page (w_current, "%new-page-hook", toplevel->page_current);
}
gschem_page_view_set_page (page_view,
toplevel->page_current);
o_undo_savestate (w_current, toplevel->page_current, UNDO_ALL);
/* This line is generally un-needed, however if some code
* wants to open a page, yet not bring it to the front, it is
* needed needed to add it into the page manager. Otherwise,
* it will get done in x_window_set_current_page(...)
*/
x_pagesel_update (w_current); /* ??? */
g_free (fn);
return page;
}
/*! \brief Handles all the options of the autonumber text dialog
* \par Function Description
* This function is the master of all autonumber code. It receives the options of
* the the autonumber text dialog in an <B>AUTONUMBER_TEXT</B> structure.
* First it collects all pages of a hierarchical schematic.
* Second it gets all matching text elements for the searchtext.
* Then it renumbers all text elements of all schematic pages. The renumbering
* follows the rules of the parameters given in the autonumber text dialog.
*/
void autonumber_text_autonumber(AUTONUMBER_TEXT *autotext)
{
GList *pages;
GList *searchtext_list=NULL;
GList *text_item, *obj_item, *page_item;
OBJECT *o_current;
GschemToplevel *w_current;
gchar *searchtext;
gchar *scope_text;
gchar *new_searchtext;
gint i, number, slot;
GList *o_list = NULL;
const GList *iter;
w_current = autotext->w_current;
autotext->current_searchtext = NULL;
autotext->root_page = 1;
autotext->used_numbers = NULL;
autotext->free_slots = NULL;
autotext->used_slots = NULL;
scope_text = g_list_first(autotext->scope_text)->data;
/* Step1: get all pages of the hierarchy */
pages = s_hierarchy_traversepages (w_current->toplevel,
w_current->toplevel->page_current,
HIERARCHY_NODUPS);
/* g_list_foreach(pages, (GFunc) s_hierarchy_print_page, NULL); */
/* Step2: if searchtext has an asterisk at the end we have to find
all matching searchtextes.
Example: "refdes=*" will match each text that starts with "refdes="
and has a trailing "?" or a trailing number if the "all"-option is set.
We get a list of possible prefixes: refdes=R, refdes=C.
If there is only one search pattern, it becomes a single item
in the searchtext list */
if (strlen(scope_text) == 0) {
s_log_message(_("No searchstring given in autonumber text.\n"));
return; /* error */
}
else if (g_str_has_suffix(scope_text,"?") == TRUE) {
/* single searchtext, strip of the "?" */
searchtext = g_strndup(scope_text, strlen(scope_text)-1);
searchtext_list=g_list_append (searchtext_list, searchtext);
}
else if (g_str_has_suffix(scope_text,"*") == TRUE) {
/* strip of the "*" */
searchtext = g_strndup(scope_text, strlen(scope_text)-1);
/* collect all the possible searchtexts in all pages of the hierarchy */
for (page_item = pages; page_item != NULL; page_item = g_list_next(page_item)) {
s_page_goto(w_current->toplevel, page_item->data);
gschem_toplevel_page_changed (w_current);
/* iterate over all objects an look for matching searchtext's */
for (iter = s_page_objects (w_current->toplevel->page_current);
iter != NULL;
iter = g_list_next (iter)) {
o_current = iter->data;
if (o_current->type == OBJ_TEXT) {
if (autotext->scope_number == SCOPE_HIERARCHY
|| autotext->scope_number == SCOPE_PAGE
|| ((autotext->scope_number == SCOPE_SELECTED) && (o_current->selected))) {
const gchar *str = o_text_get_string (w_current->toplevel, o_current);
if (g_str_has_prefix (str, searchtext)) {
/* the beginnig of the current text matches with the searchtext now */
/* strip of the trailing [0-9?] chars and add it too the searchtext */
for (i = strlen (str)-1;
(i >= strlen(searchtext))
&& (str[i] == '?'
|| isdigit( (int) (str[i]) ));
i--)
; /* void */
new_searchtext = g_strndup (str, i+1);
if (g_list_find_custom(searchtext_list, new_searchtext,
(GCompareFunc) strcmp) == NULL ) {
searchtext_list = g_list_append(searchtext_list, new_searchtext);
}
else {
g_free(new_searchtext);
}
}
}
}
}
if (autotext->scope_number == SCOPE_SELECTED || autotext->scope_number == SCOPE_PAGE)
break; /* search only in the first page */
}
g_free(searchtext);
}
else {
s_log_message(_("No '*' or '?' given at the end of the autonumber text.\n"));
return;
}
/* Step3: iterate over the search items in the list */
for (text_item=searchtext_list; text_item !=NULL; text_item=g_list_next(text_item)) {
autotext->current_searchtext = text_item->data;
/* printf("autonumber_text_autonumber: searchtext %s\n", autotext->current_searchtext); */
/* decide whether to renumber page by page or get a global used-list */
if (autotext->scope_skip == SCOPE_HIERARCHY) { /* whole hierarchy database */
/* renumbering all means that no db is required */
if (!(autotext->scope_number == SCOPE_HIERARCHY
&& autotext->scope_overwrite)) {
for (page_item = pages; page_item != NULL; page_item = g_list_next(page_item)) {
autotext->root_page = (pages->data == page_item->data);
s_page_goto(w_current->toplevel, page_item->data);
gschem_toplevel_page_changed (w_current);
autonumber_get_used(w_current, autotext);
}
}
}
/* renumber the elements */
for (page_item = pages; page_item != NULL; page_item = g_list_next(page_item)) {
s_page_goto(w_current->toplevel, page_item->data);
gschem_toplevel_page_changed (w_current);
autotext->root_page = (pages->data == page_item->data);
/* build a page database if we're numbering pagebypage or selection only*/
if (autotext->scope_skip == SCOPE_PAGE || autotext->scope_skip == SCOPE_SELECTED) {
autonumber_get_used(w_current, autotext);
}
/* RENUMBER CODE FOR ONE PAGE AND ONE SEARCHTEXT*/
/* 1. get objects to renumber */
for (iter = s_page_objects (w_current->toplevel->page_current);
iter != NULL;
iter = g_list_next (iter)) {
o_current = iter->data;
if (autonumber_match(autotext, o_current, &number) == AUTONUMBER_RENUMBER) {
/* put number into the used list */
o_list = g_list_append(o_list, o_current);
}
}
/* 2. sort object list */
switch (autotext->order) {
case AUTONUMBER_SORT_YX:
o_list=g_list_sort(o_list, autonumber_sort_yx);
break;
case AUTONUMBER_SORT_YX_REV:
o_list=g_list_sort(o_list, autonumber_sort_yx_rev);
break;
case AUTONUMBER_SORT_XY:
o_list=g_list_sort(o_list, autonumber_sort_xy);
break;
case AUTONUMBER_SORT_XY_REV:
o_list=g_list_sort(o_list, autonumber_sort_xy_rev);
break;
case AUTONUMBER_SORT_DIAGONAL:
o_list=g_list_sort(o_list, autonumber_sort_diagonal);
break;
default:
; /* unsorted file order */
}
/* 3. renumber/reslot the objects */
for(obj_item=o_list; obj_item != NULL; obj_item=g_list_next(obj_item)) {
o_current= obj_item->data;
if(autotext->removenum) {
autonumber_remove_number(autotext, o_current);
} else {
/* get valid numbers from the database */
autonumber_get_new_numbers(autotext, o_current, &number, &slot);
/* and apply it. TODO: join these two functions */
autonumber_apply_new_text(autotext, o_current, number, slot);
}
}
g_list_free(o_list);
o_list = NULL;
/* destroy the page database */
if (autotext->scope_skip == SCOPE_PAGE
|| autotext->scope_skip == SCOPE_SELECTED)
autonumber_clear_database(autotext);
if (autotext->scope_number == SCOPE_SELECTED
|| autotext->scope_number == SCOPE_PAGE)
break; /* only renumber the parent page (the first page) */
}
autonumber_clear_database(autotext); /* cleanup */
}
/* cleanup and redraw all*/
g_list_foreach(searchtext_list, (GFunc) g_free, NULL);
g_list_free(searchtext_list);
s_page_goto(w_current->toplevel, pages->data); /* go back to the root page */
gschem_toplevel_page_changed (w_current);
gschem_page_view_invalidate_all (gschem_toplevel_get_current_page_view (w_current));
g_list_free(pages);
o_undo_savestate_old(w_current, UNDO_ALL);
}
/*! \brief Do autosave on all pages that are marked.
* \par Function Description
* Looks for pages with the do_autosave_backup flag activated and
* autosaves them.
*
* \param [in] w_current The GschemToplevel object to search for autosave's.
*/
void o_autosave_backups(GschemToplevel *w_current)
{
TOPLEVEL *toplevel = gschem_toplevel_get_toplevel (w_current);
GList *iter;
PAGE *p_save, *p_current;
gchar *backup_filename;
gchar *real_filename;
gchar *only_filename;
gchar *dirname;
mode_t saved_umask;
mode_t mask;
struct stat st;
/* save current page */
p_save = toplevel->page_current;
for ( iter = geda_list_get_glist( toplevel->pages );
iter != NULL;
iter = g_list_next( iter ) ) {
p_current = (PAGE *)iter->data;
if (p_current->do_autosave_backup == 0) {
continue;
}
if (p_current->ops_since_last_backup != 0) {
/* make p_current the current page of toplevel */
s_page_goto (toplevel, p_current);
gschem_toplevel_page_changed (w_current);
/* Get the real filename and file permissions */
real_filename = follow_symlinks (p_current->page_filename, NULL);
if (real_filename == NULL) {
s_log_message (_("o_autosave_backups: Can't get the real filename of %s."), p_current->page_filename);
} else {
/* Get the directory in which the real filename lives */
dirname = g_path_get_dirname (real_filename);
only_filename = g_path_get_basename(real_filename);
backup_filename = g_strdup_printf("%s%c"AUTOSAVE_BACKUP_FILENAME_STRING,
dirname, G_DIR_SEPARATOR, only_filename);
/* If there is not an existing file with that name, compute the
* permissions and uid/gid that we will use for the newly-created file.
*/
if (stat (real_filename, &st) != 0) {
#if defined(HAVE_GETUID) && defined(HAVE_GETGID)
struct stat dir_st;
int result;
#endif
/* Use default permissions */
saved_umask = umask(0);
st.st_mode = 0666 & ~saved_umask;
umask(saved_umask);
#if defined(HAVE_GETUID) && defined(HAVE_GETGID)
st.st_uid = getuid ();
result = stat (dirname, &dir_st);
if (result == 0 && (dir_st.st_mode & S_ISGID))
st.st_gid = dir_st.st_gid;
else
st.st_gid = getgid ();
#endif
}
g_free (dirname);
g_free (only_filename);
g_free (real_filename);
/* Make the backup file writable before saving a new one */
if ( g_file_test (backup_filename, G_FILE_TEST_EXISTS) &&
(! g_file_test (backup_filename, G_FILE_TEST_IS_DIR))) {
saved_umask = umask(0);
if (chmod(backup_filename, (S_IWRITE|S_IWGRP|S_IWOTH) &
((~saved_umask) & 0777)) != 0) {
s_log_message (_("Could NOT set previous backup file [%s] read-write\n"),
backup_filename);
}
umask(saved_umask);
}
if (o_save (toplevel,
s_page_objects (toplevel->page_current),
backup_filename, NULL)) {
p_current->ops_since_last_backup = 0;
p_current->do_autosave_backup = 0;
/* Make the backup file readonly so a 'rm *' command will ask
the user before deleting it */
saved_umask = umask(0);
mask = (S_IWRITE|S_IWGRP|S_IEXEC|S_IXGRP|S_IXOTH);
mask = (~mask)&0777;
mask &= ((~saved_umask) & 0777);
if (chmod(backup_filename,mask) != 0) {
s_log_message (_("Could NOT set backup file [%s] readonly\n"),
backup_filename);
}
umask(saved_umask);
} else {
s_log_message (_("Could NOT save backup file [%s]\n"),
backup_filename);
}
g_free (backup_filename);
}
}
}
/* restore current page */
s_page_goto (toplevel, p_save);
gschem_toplevel_page_changed (w_current);
}
/*! \brief Asks for confirmation before closing a window.
* \par Function Description
* This function asks the user to confirm its closing order for
* the given window.
*
* The user is given the possibility to save the pages that currently
* have unsaved changes, if any.
*
* It returns TRUE if the user really accepts the close of the
* window. Otherwise the user has somehow cancelled and the window
* must not be closed.
*
* \param [in] w_current The toplevel environment.
* \returns TRUE if the window can be closed, FALSE otherwise.
*/
gboolean
x_dialog_close_window (GschemToplevel *w_current)
{
TOPLEVEL *toplevel = gschem_toplevel_get_toplevel (w_current);
GList *iter;
GtkWidget *dialog;
PAGE *p_current;
PAGE *keep_page;
GList *unsaved_pages, *p_unsaved;
gboolean ret = FALSE;
keep_page = toplevel->page_current;
for ( iter = geda_list_get_glist( toplevel->pages ), unsaved_pages = NULL;
iter != NULL;
iter = g_list_next( iter ) ) {
p_current = (PAGE*)iter->data;
if (p_current->CHANGED) {
unsaved_pages = g_list_append (unsaved_pages, (gpointer)p_current);
}
}
if (unsaved_pages == NULL) {
/* no page with unsaved changes, close window */
return TRUE;
}
dialog = GTK_WIDGET (g_object_new (TYPE_CLOSE_CONFIRMATION_DIALOG,
"unsaved-pages", unsaved_pages,
NULL));
gtk_window_set_transient_for (GTK_WINDOW (dialog),
GTK_WINDOW (w_current->main_window));
g_list_free (unsaved_pages);
switch (gtk_dialog_run (GTK_DIALOG (dialog))) {
case GTK_RESPONSE_NO:
/* action selected: close without saving */
/* discard changes, ok to close window */
ret = TRUE;
break;
case GTK_RESPONSE_YES:
/* action selected: save */
g_object_get (dialog,
"selected-pages", &unsaved_pages,
NULL);
for (p_unsaved = unsaved_pages, ret = TRUE;
p_unsaved != NULL;
p_unsaved = g_list_next (p_unsaved)) {
p_current = (PAGE*)p_unsaved->data;
s_page_goto (toplevel, p_current);
gschem_toplevel_page_changed (w_current);
i_callback_file_save(w_current, 0, NULL);
/* if user cancelled previous, do not close window */
ret &= !p_current->CHANGED;
}
g_list_free (unsaved_pages);
break;
case GTK_RESPONSE_CANCEL:
/* action selected: cancel */
/* fall through */
default:
/* Hit when the user breaks out of the dialog with the escape key
* or otherwise destroys the dialog window without a proper response */
ret = FALSE;
break;
}
gtk_widget_destroy (dialog);
/* Switch back to the page we were on */
g_return_val_if_fail (keep_page != NULL, ret);
s_page_goto (toplevel, keep_page);
gschem_toplevel_page_changed (w_current);
return ret;
}
