Split common utility functions for libalpm and pacman

There is duplicated code in the util.c files in the libalpm and pacman
source code. Split this into a separate file so that it can be shared
via a symlink. This prevents code divergence between the two code bases.

Also, move mbasename and mdirname from pacman/util.c into util-common.c
in preparation for the following patch that uses them to add an extension
to pacsave files.

Signed-off-by: Allan McRae <allan@archlinux.org>
This commit is contained in:
Allan McRae 2013-01-03 20:49:33 +10:00
parent 965e1de217
commit 27d9c25ee2
15 changed files with 157 additions and 95 deletions

View File

@ -3,7 +3,7 @@ if WANT_DOC
SUBDIRS += doc
endif
DIST_SUBDIRS = $(SUBDIRS) contrib
DIST_SUBDIRS = $(SUBDIRS) contrib src/common
ACLOCAL_AMFLAGS = -I m4 --install

View File

@ -462,6 +462,7 @@ AC_CONFIG_FILES([
lib/libalpm/Makefile
lib/libalpm/po/Makefile.in
lib/libalpm/libalpm.pc
src/common/Makefile
src/pacman/Makefile
src/pacman/po/Makefile.in
src/util/Makefile

View File

@ -53,6 +53,7 @@ libalpm_la_SOURCES = \
sync.h sync.c \
trans.h trans.c \
util.h util.c \
util-common.h util-common.c \
version.c
if !HAVE_LIBSSL

1
lib/libalpm/util-common.c Symbolic link
View File

@ -0,0 +1 @@
../../src/common/util-common.c

1
lib/libalpm/util-common.h Symbolic link
View File

@ -0,0 +1 @@
../../src/common/util-common.h

View File

@ -1256,37 +1256,4 @@ void _alpm_alloc_fail(size_t size)
fprintf(stderr, "alloc failure: could not allocate %zd bytes\n", size);
}
#ifndef HAVE_STRNDUP
/* A quick and dirty implementation derived from glibc */
/** Determines the length of a fixed-size string.
* @param s string to be measured
* @param max maximum number of characters to search for the string end
* @return length of s or max, whichever is smaller
*/
static size_t strnlen(const char *s, size_t max)
{
register const char *p;
for(p = s; *p && max--; ++p);
return (p - s);
}
/** Copies a string.
* Returned string needs to be freed
* @param s string to be copied
* @param n maximum number of characters to copy
* @return pointer to the new string on success, NULL on error
*/
char *strndup(const char *s, size_t n)
{
size_t len = strnlen(s, n);
char *new = (char *) malloc(len + 1);
if(new == NULL)
return NULL;
new[len] = '\0';
return (char *)memcpy(new, s, len);
}
#endif
/* vim: set ts=2 sw=2 noet: */

View File

@ -28,6 +28,7 @@
#include "alpm.h"
#include "package.h" /* alpm_pkg_t */
#include "handle.h" /* alpm_handle_t */
#include "util-common.h"
#include <stdio.h>
#include <string.h>
@ -142,10 +143,6 @@ int _alpm_fnmatch(const void *pattern, const void *string);
char *strsep(char **, const char *);
#endif
#ifndef HAVE_STRNDUP
char *strndup(const char *s, size_t n);
#endif
/* check exported library symbols with: nm -C -D <lib> */
#define SYMEXPORT __attribute__((visibility("default")))
#define SYMHIDDEN __attribute__((visibility("internal")))

4
src/common/Makefile.am Normal file
View File

@ -0,0 +1,4 @@
EXTRA_DIST = \
util-common.h util-common.c
# vim:set ts=2 sw=2 noet:

109
src/common/util-common.c Normal file
View File

@ -0,0 +1,109 @@
/*
* util-common.c
*
* Copyright (c) 2006-2012 Pacman Development Team <pacman-dev@archlinux.org>
*
* 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 program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <stdlib.h>
#include <string.h>
#include "util-common.h"
/** Parse the basename of a program from a path.
* @param path path to parse basename from
*
* @return everything following the final '/'
*/
const char *mbasename(const char *path)
{
const char *last = strrchr(path, '/');
if(last) {
return last + 1;
}
return path;
}
/** Parse the dirname of a program from a path.
* The path returned should be freed.
* @param path path to parse dirname from
*
* @return everything preceding the final '/'
*/
char *mdirname(const char *path)
{
char *ret, *last;
/* null or empty path */
if(path == NULL || path == '\0') {
return strdup(".");
}
if((ret = strdup(path)) == NULL) {
return NULL;
}
last = strrchr(ret, '/');
if(last != NULL) {
/* we found a '/', so terminate our string */
if(last == ret) {
/* return "/" for root */
last++;
}
*last = '\0';
return ret;
}
/* no slash found */
free(ret);
return strdup(".");
}
#ifndef HAVE_STRNDUP
/* A quick and dirty implementation derived from glibc */
/** Determines the length of a fixed-size string.
* @param s string to be measured
* @param max maximum number of characters to search for the string end
* @return length of s or max, whichever is smaller
*/
static size_t strnlen(const char *s, size_t max)
{
register const char *p;
for(p = s; *p && max--; ++p);
return (p - s);
}
/** Copies a string.
* Returned string needs to be freed
* @param s string to be copied
* @param n maximum number of characters to copy
* @return pointer to the new string on success, NULL on error
*/
char *strndup(const char *s, size_t n)
{
size_t len = strnlen(s, n);
char *new = (char *) malloc(len + 1);
if(new == NULL)
return NULL;
new[len] = '\0';
return (char *)memcpy(new, s, len);
}
#endif
/* vim: set ts=2 sw=2 noet: */

32
src/common/util-common.h Normal file
View File

@ -0,0 +1,32 @@
/*
* util-common.h
*
* Copyright (c) 2006-2013 Pacman Development Team <pacman-dev@archlinux.org>
*
* 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 program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _PM_UTIL_COMMON_H
#define _PM_UTIL_COMMON_H
const char *mbasename(const char *path);
char *mdirname(const char *path);
#ifndef HAVE_STRNDUP
char *strndup(const char *s, size_t n);
#endif
#endif /* _PM_UTIL_COMMON_H */
/* vim: set ts=2 sw=2 noet: */

View File

@ -38,7 +38,8 @@ pacman_SOURCES = \
sync.c \
callback.h callback.c \
upgrade.c \
util.h util.c
util.h util.c \
util-common.h util-common.c
LDADD = $(LTLIBINTL) $(top_builddir)/lib/libalpm/.libs/libalpm.la

1
src/pacman/util-common.c Symbolic link
View File

@ -0,0 +1 @@
../common/util-common.c

1
src/pacman/util-common.h Symbolic link
View File

@ -0,0 +1 @@
../common/util-common.h

View File

@ -210,56 +210,6 @@ int rmrf(const char *path)
}
}
/** Parse the basename of a program from a path.
* @param path path to parse basename from
*
* @return everything following the final '/'
*/
const char *mbasename(const char *path)
{
const char *last = strrchr(path, '/');
if(last) {
return last + 1;
}
return path;
}
/** Parse the dirname of a program from a path.
* The path returned should be freed.
* @param path path to parse dirname from
*
* @return everything preceding the final '/'
*/
char *mdirname(const char *path)
{
char *ret, *last;
/* null or empty path */
if(path == NULL || path == '\0') {
return strdup(".");
}
if((ret = strdup(path)) == NULL) {
return NULL;
}
last = strrchr(ret, '/');
if(last != NULL) {
/* we found a '/', so terminate our string */
if(last == ret) {
/* return "/" for root */
last++;
}
*last = '\0';
return ret;
}
/* no slash found */
free(ret);
return strdup(".");
}
/* output a string, but wrap words properly with a specified indentation
*/
void indentprint(const char *str, unsigned short indent, unsigned short cols)

View File

@ -26,6 +26,8 @@
#include <alpm_list.h>
#include "util-common.h"
#ifdef ENABLE_NLS
#include <libintl.h> /* here so it doesn't need to be included elsewhere */
/* define _() as shortcut for gettext() */
@ -49,8 +51,6 @@ int needs_root(void);
int check_syncdbs(size_t need_repos, int check_valid);
unsigned short getcols(int fd);
int rmrf(const char *path);
const char *mbasename(const char *path);
char *mdirname(const char *path);
void indentprint(const char *str, unsigned short indent, unsigned short cols);
size_t strtrim(char *str);
char *strreplace(const char *str, const char *needle, const char *replace);
@ -80,10 +80,6 @@ int pm_asprintf(char **string, const char *format, ...);
int pm_vfprintf(FILE *stream, alpm_loglevel_t level, const char *format, va_list args) __attribute__((format(printf,3,0)));
int pm_vasprintf(char **string, alpm_loglevel_t level, const char *format, va_list args) __attribute__((format(printf,3,0)));
#ifndef HAVE_STRNDUP
char *strndup(const char *s, size_t n);
#endif
#endif /* _PM_UTIL_H */
/* vim: set ts=2 sw=2 noet: */