GNOME.org
 

[nautilus-actions] Refactoring: rename na-utils to na-core-utils

commit 10db600b3dd4fcbe674c700af7d7a60f50bb618f
Author: Pierre Wieser <pwieser trychlos org>
Date:   Mon Feb 15 16:48:15 2010 +0100

    Refactoring: rename na-utils to na-core-utils
    
    Install header in src/api/
    Install code in src/core/.

 ChangeLog                |    9 +
 src/api/Makefile.am      |   33 +--
 src/api/na-core-utils.h  |   78 +++++
 src/core/Makefile.am     |   68 ++---
 src/core/na-core-utils.c |  448 +++++++++++++++++++++++++++
 src/core/na-utils.c      |  756 ----------------------------------------------
 src/core/na-utils.h      |   87 ------
 7 files changed, 574 insertions(+), 905 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index c12eedf..72ec40c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,14 @@
 2009-02-15 Pierre Wieser <pwieser trychlos org>
 
+	Rename src/core/na-utils.h to src/api/na-core-utils.h
+	Rename src/core/na-utils.c to src/core/na-core-utils.c
+
+	* src/api/Makefile.am:
+	* src/core/Makefile.am: Updated accordingly.
+
+	* src/core/na-core-utils.c:
+	* src/core/na-core-utils.h: Normalize functions names.
+
 	Merge src/private/ and src/runtime to src/core/
 	Rename src/api/na-api.h to src/api/na-extension.h
 
diff --git a/src/api/Makefile.am b/src/api/Makefile.am
index 723837b..d359c30 100644
--- a/src/api/Makefile.am
+++ b/src/api/Makefile.am
@@ -26,37 +26,16 @@
 #   Pierre Wieser <pwieser trychlos org>
 #   ... and many others (see AUTHORS)
 
-pkglib_LTLIBRARIES=libna-api.la
+api_includedir = $(pkgincludedir)
 
-AM_CPPFLAGS += \
-	-I $(top_srcdir)									\
-	$(NAUTILUS_ACTIONS_CFLAGS)							\
-	-DG_LOG_DOMAIN=\"${NA_LOGDOMAIN_API}\"				\
-	$(NULL)
-
-libna_api_includedir = $(pkgincludedir)/api
-
-libna_api_include_HEADERS = \
-	na-api.h											\
+api_include_HEADERS = \
+	na-extension.h										\
+	\
+	\
+	na-core-utils.h										\
 	na-dbus.h											\
 	na-gconf-keys.h										\
 	na-gconf-monitor.h									\
 	na-iio-provider.h									\
 	na-object-api.h										\
 	$(NULL)
-
-libna_api_la_SOURCES = \
-	na-gconf-monitor.c									\
-	na-iio-provider.c									\
-	$(NULL)
-
-libna_api_la_LIBADD = \
-	$(NULL)
-
-#VERSION_INFO = `echo @VERSION@ | $(SED) -e 's/\./:/g' -e 's/[a-aA-Z]//g'`
-VERSION_INFO = 1:0:0
-libna_api_la_LDFLAGS = \
-	-module 											\
-	-no-undefined										\
-	-version-number $(VERSION_INFO)						\
-	$(NULL)
diff --git a/src/api/na-core-utils.h b/src/api/na-core-utils.h
new file mode 100644
index 0000000..7ec2130
--- /dev/null
+++ b/src/api/na-core-utils.h
@@ -0,0 +1,78 @@
+/*
+ * Nautilus Actions
+ * A Nautilus extension which offers configurable context menu actions.
+ *
+ * Copyright (C) 2005 The GNOME Foundation
+ * Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
+ * Copyright (C) 2009, 2010 Pierre Wieser and others (see AUTHORS)
+ *
+ * This Program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ *
+ * This Program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public
+ * License along with this Library; see the file COPYING.  If not,
+ * write to the Free Software Foundation, Inc., 59 Temple Place,
+ * Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * Authors:
+ *   Frederic Ruaudel <grumz grumz net>
+ *   Rodrigo Moya <rodrigo gnome-db org>
+ *   Pierre Wieser <pwieser trychlos org>
+ *   ... and many others (see AUTHORS)
+ */
+
+#ifndef __NAUTILUS_ACTIONS_API_NA_CORE_UTILS_H__
+#define __NAUTILUS_ACTIONS_API_NA_CORE_UTILS_H__
+
+/**
+ * SECTION: na_core_utils
+ * @short_description: Core library utilities.
+ * @include: nautilus-action/na-core-utils.h
+ */
+
+#include <glib.h>
+
+G_BEGIN_DECLS
+
+/* boolean manipulation
+ */
+gboolean na_core_utils_boolean_from_string( const gchar *string );
+
+/* string manipulation
+ */
+gchar   *na_core_utils_str_remove_suffix( const gchar *string, const gchar *suffix );
+gchar   *na_core_utils_str_add_prefix( const gchar *prefix, const gchar *str );
+
+/* some functions to get or set GSList list of strings
+ */
+GSList  *na_core_utils_slist_duplicate( GSList *list );
+void     na_core_utils_slist_dump( GSList *list );
+GSList  *na_core_utils_slist_from_split( const gchar *string, const gchar *separator );
+GSList  *na_core_utils_slist_from_str_array( const gchar **str_array );
+GSList  *na_core_utils_slist_remove_string( GSList *list, const gchar *string );
+gboolean na_core_utils_slist_find( GSList *list, const gchar *str );
+gboolean na_core_utils_slist_are_equal( GSList *a, GSList *b );
+void     na_core_utils_slist_free( GSList *slist );
+
+/* directory management
+ */
+gboolean na_core_utils_dir_is_writable( const gchar *path );
+
+/* file management
+ */
+gboolean na_core_utils_file_delete( const gchar *path );
+
+/* miscellaneous
+ */
+void     na_core_utils_print_version( void );
+
+G_END_DECLS
+
+#endif /* __NAUTILUS_ACTIONS_API_NA_CORE_UTILS_H__ */
diff --git a/src/core/Makefile.am b/src/core/Makefile.am
index c9bfd30..4890519 100644
--- a/src/core/Makefile.am
+++ b/src/core/Makefile.am
@@ -26,47 +26,45 @@
 #   Pierre Wieser <pwieser trychlos org>
 #   ... and many others (see AUTHORS)
 
-pkglib_LTLIBRARIES = libna-runtime.la
+pkglib_LTLIBRARIES = libna-core.la
 
 AM_CPPFLAGS += \
-	-I $(top_srcdir)											\
-	-I $(top_srcdir)/nautilus-actions							\
-	-DPKGLIBDIR=\""$(pkglibdir)"\"								\
-	-DPKGDATADIR=\"$(pkgdatadir)\"								\
-	-DGNOMELOCALEDIR=\""$(datadir)/locale"\"					\
-	-DG_LOG_DOMAIN=\"${NA_LOGDOMAIN_RUNTIME}\"					\
-	$(NAUTILUS_ACTIONS_CFLAGS)									\
+	-I $(top_srcdir)									\
+	-DPKGLIBDIR=\""$(pkglibdir)"\"						\
+	-DGNOMELOCALEDIR=\""$(datadir)/locale"\"			\
+	-DG_LOG_DOMAIN=\"${NA_LOGDOMAIN_RUNTIME}\"			\
+	$(NAUTILUS_ACTIONS_CFLAGS)							\
 	$(NULL)
 
-libna_runtime_la_SOURCES = \
-	na-gconf-utils.c											\
-	na-gconf-utils.h											\
-	na-iabout.c													\
-	na-iabout.h													\
-	na-io-provider.c											\
-	na-io-provider.h											\
-	na-ipivot-consumer.c										\
-	na-ipivot-consumer.h										\
-	na-iprefs.c													\
-	na-iprefs.h													\
-	na-module.c													\
-	na-module.h													\
-	na-pivot.c													\
-	na-pivot.h													\
-	na-utils.c													\
-	na-utils.h													\
-	na-xml-names.h												\
-	na-xml-writer.c												\
-	na-xml-writer.h												\
+libna_core_la_SOURCES = \
+	na-core-utils.c										\
+	\
+	na-gconf-utils.c									\
+	na-gconf-utils.h									\
+	na-iabout.c											\
+	na-iabout.h											\
+	na-io-provider.c									\
+	na-io-provider.h									\
+	na-ipivot-consumer.c								\
+	na-ipivot-consumer.h								\
+	na-iprefs.c											\
+	na-iprefs.h											\
+	na-module.c											\
+	na-module.h											\
+	na-pivot.c											\
+	na-pivot.h											\
+	na-utils.c											\
+	na-utils.h											\
+	na-xml-names.h										\
+	na-xml-writer.c										\
+	na-xml-writer.h										\
 	$(NULL)
 
-libna_runtime_la_LIBADD = \
-	-L$(top_builddir)/nautilus-actions/api		-lna-api		\
+libna_core_la_LIBADD = \
 	$(NULL)
 
-VERSION_INFO = 1:0:0
-libna_runtime_la_LDFLAGS = \
-	-module														\
-	-no-undefined												\
-	-version-number $(VERSION_INFO)								\
+VERSION_INFO = `echo @PACKAGE_VERSION@ | sed 's/\./:/g'`
+libna_core_la_LDFLAGS = \
+	-no-undefined										\
+	-version-number $(VERSION_INFO)						\
 	$(NULL)
diff --git a/src/core/na-core-utils.c b/src/core/na-core-utils.c
new file mode 100644
index 0000000..1591a79
--- /dev/null
+++ b/src/core/na-core-utils.c
@@ -0,0 +1,448 @@
+/*
+ * Nautilus Actions
+ * A Nautilus extension which offers configurable context menu actions.
+ *
+ * Copyright (C) 2005 The GNOME Foundation
+ * Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
+ * Copyright (C) 2009, 2010 Pierre Wieser and others (see AUTHORS)
+ *
+ * This Program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ *
+ * This Program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public
+ * License along with this Library; see the file COPYING.  If not,
+ * write to the Free Software Foundation, Inc., 59 Temple Place,
+ * Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * Authors:
+ *   Frederic Ruaudel <grumz grumz net>
+ *   Rodrigo Moya <rodrigo gnome-db org>
+ *   Pierre Wieser <pwieser trychlos org>
+ *   ... and many others (see AUTHORS)
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include <errno.h>
+#include <string.h>
+
+#include <gio/gio.h>
+#include <glib/gstdio.h>
+
+#include <api/na-core-utils.h>
+
+#include "na-iabout.h"
+
+static GSList *text_to_string_list( const gchar *text, const gchar *separator, const gchar *default_value );
+
+/**
+ * na_core_utils_boolean_from_string
+ * @string: a string to be converted.
+ *
+ * Returns: %TRUE if the string evaluates to "true" (case insensitive),
+ * %FALSE else.
+ */
+gboolean
+na_core_utils_boolean_from_string( const gchar *string )
+{
+	return( g_ascii_strcasecmp( string, "true" ) == 0 );
+}
+
+/**
+ * na_core_utils_str_remove_suffix:
+ * @string: source string.
+ * @suffix: suffix to be removed from @string.
+ *
+ * Returns: a newly allocated string, which is a copy of the source @string,
+ * minus the removed @suffix if present. If @strings doesn't terminate with
+ * @suffix, then the returned string is equal to source @string.
+ *
+ * The returned string should be g_free() by the caller.
+ */
+gchar *
+na_core_utils_str_remove_suffix( const gchar *string, const gchar *suffix )
+{
+	gchar *removed;
+	gchar *ptr;
+
+	removed = g_strdup( string );
+
+	if( g_str_has_suffix( string, suffix )){
+		ptr = g_strrstr( removed, suffix );
+		ptr[0] = '\0';
+	}
+
+	return( removed );
+}
+
+/**
+ * na_core_utils_str_add_prefix:
+ * @prefix: the prefix to be prepended.
+ * @str: a multiline string.
+ *
+ * Appends a prefix to each line of the string.
+ *
+ * Returns: a new string which should be g_free() by the caller.
+ */
+gchar *
+na_core_utils_str_add_prefix( const gchar *prefix, const gchar *str )
+{
+	GSList *list, *il;
+	GString *result;
+
+	list = text_to_string_list( str, "\n", NULL );
+	result = g_string_new( "" );
+
+	for( il = list ; il ; il = il->next ){
+		g_string_append_printf( result, "%s%s\n", prefix, ( gchar * ) il->data );
+	}
+
+	na_core_utils_slist_free( list );
+
+	return( g_string_free( result, FALSE ));
+}
+
+/**
+ * na_core_utils_slist_duplicate:
+ * @source_slist: the #GSList to be duplicated.
+ *
+ * Returns: a #GSList of strings.
+ *
+ * The returned list should be #na_core_utils_slist_free() by the caller.
+ */
+GSList *
+na_core_utils_slist_duplicate( GSList *source_slist )
+{
+	GSList *dest_slist, *it;
+
+	dest_slist = NULL;
+
+	for( it = source_slist ; it != NULL ; it = it->next ){
+		dest_slist = g_slist_prepend( dest_slist, g_strdup(( gchar * ) it->data ) );
+	}
+
+	dest_slist = g_slist_reverse( dest_slist );
+
+	return( dest_slist );
+}
+
+/**
+ * na_core_utils_slist_dump:
+ * @list: a list of strings.
+ *
+ * Dumps the content of a list of strings.
+ */
+void
+na_core_utils_slist_dump( GSList *list )
+{
+	static const gchar *thisfn = "na_core_utils_slist_dump";
+	GSList *i;
+	int c;
+
+	g_debug( "%s: list at %p has %d elements", thisfn, ( void * ) list, g_slist_length( list ));
+	for( i=list, c=0 ; i ; i=i->next, c++ ){
+		gchar *s = ( gchar * ) i->data;
+		g_debug( "%s: %2d - %s", thisfn, c, s );
+	}
+}
+
+/**
+ * na_core_utils_slist_from_split:
+ * @@text: a string to be splitted.
+ *
+ * Returns: a #GSList with the list of strings after having been splitted.
+ *
+ * The returned #GSList should be #na_core_utils_slist_free() by the caller.
+ */
+GSList *
+na_core_utils_slist_from_split( const gchar *text, const gchar *separator )
+{
+	GSList *slist;
+	gchar **tokens;
+	gchar *source, *tmp;
+
+	if( !text ){
+		return( NULL );
+	}
+
+	source = g_strdup( text );
+	tmp = g_strstrip( source );
+
+	if( !g_utf8_strlen( tmp, -1 )){
+		return( NULL );
+	}
+
+	tokens = g_strsplit( tmp, separator, -1 );
+	slist = na_core_utils_slist_from_str_array(( const gchar ** ) tokens );
+	g_strfreev( tokens );
+
+	g_free( source );
+
+	return( slist );
+}
+
+/**
+ * na_core_utils_slist_from_str_array:
+ * @str_array: an NULL-terminated array of strings.
+ *
+ * Returns: a #GSList list of strings, which should be #na_core_utils_slist_free()
+ * by the caller.
+ */
+GSList *
+na_core_utils_slist_from_str_array( const gchar **str_array )
+{
+	GSList *slist;
+	gchar **idx;
+
+	slist = NULL;
+	idx = ( gchar ** ) str_array;
+
+	while( *idx ){
+		slist = g_slist_prepend( slist, g_strdup( *idx ));
+		idx++;
+	}
+
+	return( g_slist_reverse( slist ));
+}
+
+/**
+ * na_core_utils_slist_remove_string:
+ * @list: the GSList to be updated.
+ * @str: the string to be removed.
+ *
+ * Removes from the @list the item which has a string which is equal to
+ * @str.
+ *
+ * Returns: the new @list start position.
+ */
+GSList *
+na_core_utils_slist_remove_string( GSList *list, const gchar *str )
+{
+	GSList *is;
+
+	for( is = list ; is ; is = is->next ){
+		const gchar *istr = ( const gchar * ) is->data;
+		if( !g_utf8_collate( str, istr )){
+			g_free( is->data );
+			list = g_slist_delete_link( list, is );
+			break;
+		}
+	}
+
+	return( list );
+}
+
+/**
+ * na_core_utils_slist_find:
+ * @list: the GSList of strings to be searched.
+ * @str: the searched string.
+ *
+ * Search for a string in a string list.
+ *
+ * Returns: %TRUE if the string has been found in list.
+ */
+gboolean
+na_core_utils_slist_find( GSList *list, const gchar *str )
+{
+	GSList *il;
+
+	for( il = list ; il ; il = il->next ){
+		const gchar *istr = ( const gchar * ) il->data;
+		if( !g_utf8_collate( str, istr )){
+			return( TRUE );
+		}
+	}
+
+	return( FALSE );
+}
+
+/**
+ * na_core_utils_slist_are_equal:
+ * @first: a GSList of strings.
+ * @second: another GSList of strings to be compared with @first.
+ *
+ * Compare two string lists, without regards to the order.
+ *
+ * Returns: %TRUE if the two lists have same content.
+ */
+gboolean
+na_core_utils_slist_are_equal( GSList *first, GSList *second )
+{
+	GSList *il;
+
+	for( il = first ; il ; il = il->next ){
+		const gchar *str = ( const gchar * ) il->data;
+		if( !na_core_utils_slist_find( second, str )){
+			return( FALSE );
+		}
+	}
+
+	for( il = second ; il ; il = il->next ){
+		const gchar *str = ( const gchar * ) il->data;
+		if( !na_core_utils_slist_find( first, str )){
+			return( FALSE );
+		}
+	}
+
+	return( TRUE );
+}
+
+/**
+ * na_core_utils_slist_free:
+ * @list: a #GSList list of strings.
+ *
+ * Releases the strings and the list itself.
+ */
+void
+na_core_utils_slist_free( GSList *slist )
+{
+	g_slist_foreach( slist, ( GFunc ) g_free, NULL );
+	g_slist_free( slist );
+}
+
+/*
+ * split a text buffer in lines
+ */
+static GSList *
+text_to_string_list( const gchar *text, const gchar *separator, const gchar *default_value )
+{
+	GSList *strlist = NULL;
+	gchar **tokens;
+	gchar *tmp;
+	gchar *source = g_strdup( text );
+
+	tmp = g_strstrip( source );
+	if( !strlen( tmp ) && default_value ){
+		strlist = g_slist_append( strlist, g_strdup( default_value ));
+
+	} else {
+		tokens = g_strsplit( source, separator, -1 );
+		strlist = na_core_utils_slist_from_str_array(( const gchar ** ) tokens );
+		g_strfreev( tokens );
+	}
+
+	g_free( source );
+	return( strlist );
+}
+
+/**
+ * na_core_utils_dir_is_writable:
+ * @path: the path of the directory to be tested.
+ *
+ * Returns: %TRUE if the directory is writable, %FALSE else.
+ *
+ * Please note that this type of test is subject to race conditions,
+ * as the directory may become unwritable after a successful test,
+ * but before the caller has been able to actually write into it.
+ *
+ * There is no "super-test". Just try...
+ */
+gboolean
+na_core_utils_dir_is_writable( const gchar *path )
+{
+	static const gchar *thisfn = "na_core_utils_dir_is_writable";
+	GFile *file;
+	GError *error = NULL;
+	GFileInfo *info;
+	GFileType type;
+	gboolean writable;
+
+	if( !path || !g_utf8_strlen( path, -1 )){
+		return( FALSE );
+	}
+
+	file = g_file_new_for_path( path );
+	info = g_file_query_info( file,
+			G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE "," G_FILE_ATTRIBUTE_STANDARD_TYPE,
+			G_FILE_QUERY_INFO_NONE, NULL, &error );
+
+	if( error ){
+		g_warning( "%s: g_file_query_info error: %s", thisfn, error->message );
+		g_error_free( error );
+		g_object_unref( file );
+		return( FALSE );
+	}
+
+	type = g_file_info_get_file_type( info );
+	if( type != G_FILE_TYPE_DIRECTORY ){
+		g_debug( "%s: %s is not a directory", thisfn, path );
+		g_object_unref( info );
+		return( FALSE );
+	}
+
+	writable = g_file_info_get_attribute_boolean( info, G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE );
+	if( !writable ){
+		g_debug( "%s: %s is not writable", thisfn, path );
+	}
+
+	g_object_unref( info );
+
+	return( writable );
+}
+
+/**
+ * na_core_utils_file_delete:
+ * @path: the path of the file to be deleted.
+ *
+ * Returns: %TRUE if the file is successfully deleted, %FALSE else.
+ */
+gboolean
+na_core_utils_file_delete( const gchar *path )
+{
+	static const gchar *thisfn = "na_core_utils_file_delete";
+	gboolean deleted = FALSE;
+
+	if( !path || !g_utf8_strlen( path, -1 )){
+		return( FALSE );
+	}
+
+	if( g_unlink( path ) == 0 ){
+		deleted = TRUE;
+
+	} else {
+		g_warning( "%s: %s: %s", thisfn, path, g_strerror( errno ));
+	}
+
+	return( deleted );
+}
+
+/**
+ * na_core_utils_print_version:
+ *
+ * Print a version message on the console
+ *
+ * nautilus-actions-new (Nautilus-Actions) v 2.29.1
+ * Copyright (C) 2005-2007 Frederic Ruaudel
+ * Copyright (C) 2009, 2010 Pierre Wieser
+ * Nautilus-Actions is free software, licensed under GPLv2 or later.
+ */
+void
+na_core_utils_print_version( void )
+{
+	gchar *copyright;
+
+	g_print( "\n" );
+	g_print( "%s (%s) v %s\n", g_get_prgname(), PACKAGE_NAME, PACKAGE_VERSION );
+	copyright = na_iabout_get_copyright( TRUE );
+	g_print( "%s\n", copyright );
+	g_free( copyright );
+
+	g_print( "%s is free software, and is provided without any warranty. You may\n", PACKAGE_NAME );
+	g_print( "redistribute copies of %s under the terms of the GNU General Public\n", PACKAGE_NAME );
+	g_print( "License (see COPYING).\n" );
+	g_print( "\n" );
+
+	g_debug( "Current system runs Glib %d.%d.%d, Gtk+ %d.%d.%d",
+			glib_major_version, glib_minor_version, glib_micro_version,
+			gtk_major_version, gtk_minor_version, gtk_micro_version );
+	g_debug( "%s", "" );
+}
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]