1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
|
/* Start up the world of vips.
*
* 7/1/04 JC
* - 1st version
* 7/6/05
* - g_type_init() too, so we can use gobject
* 2/9/06
* - also set g_prg_name() and load plugins
* 8/12/06
* - add liboil support
* 5/2/07
* - stop a loop if we're called recursively during VIPS startup ... it
* can happen if (for example) vips_guess_prefix() fails and tries to
* i18n an error message (thanks Christian)
* 8/6/07
* - just warn if plugins fail to load correctly: too annoying to have
* VIPS refuse to start because of a dodgy plugin
* 7/11/07
* - progress feedback option
* 5/8/08
* - load plugins from libdir/vips-x.x
* 5/10/09
* - gtkdoc comments
* 14/3/10
* - init image and region before we start, we need all types to be fully
* constructed before we go parallel
* 18/9/16
* - call _setmaxstdio() on win32
*/
/*
This file is part of VIPS.
VIPS is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA
*/
/*
These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk
*/
/*
#define DEBUG
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif /*HAVE_CONFIG_H*/
#include <vips/intl.h>
#include <stdio.h>
#include <stdlib.h>
#ifdef HAVE_SYS_PARAM_H
#include <sys/param.h>
#endif /*HAVE_SYS_PARAM_H*/
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif /*HAVE_UNISTD_H*/
#ifdef HAVE_DIRECT_H
#include <direct.h>
#endif /*HAVE_DIRECT_H*/
#include <limits.h>
#include <string.h>
#ifdef HAVE_GSF
#include <gsf/gsf.h>
#endif /*HAVE_GSF*/
#include <vips/vips.h>
#include <vips/thread.h>
#include <vips/internal.h>
#include <vips/vector.h>
/* abort() on the first warning or error.
*/
int vips__fatal = 0;
/* Use in various small places where we need a mutex and it's not worth
* making a private one.
*/
GMutex *vips__global_lock = NULL;
/* Keep a copy of the argv0 here.
*/
static char *vips__argv0 = NULL;
/* Leak check on exit.
*/
int vips__leak = 0;
#ifdef DEBUG_LEAK
/* Count pixels processed per image here.
*/
GQuark vips__image_pixels_quark = 0;
#endif /*DEBUG_LEAK*/
/**
* vips_get_argv0:
*
* See also: VIPS_INIT().
*
* Returns: a pointer to an internal copy of the argv0 string passed to
* VIPS_INIT(). Do not free this value
*/
const char *
vips_get_argv0( void )
{
return( vips__argv0 );
}
/**
* VIPS_INIT:
* @ARGV0: name of application
*
* VIPS_INIT() starts up the world of VIPS. You should call this on
* program startup before using any other VIPS operations. If you do not call
* VIPS_INIT(), VIPS will call it for you when you use your first VIPS
* operation, but it may not be able to get hold of @ARGV0 and VIPS may
* therefore be unable to find its data files. It is much better to call
* this macro yourself.
*
* VIPS_INIT() is a macro, since it tries to check binary compatibility
* between the caller and the library.
*
* You may call VIPS_INIT() many times and vips_shutdown() many times, but you
* must not call VIPS_INIT() after vips_shutdown(). In other words, you cannot
* stop and restart vips.
*
* VIPS_INIT() does approximately the following:
*
* + checks that the libvips your program is expecting is
* binary-compatible with the vips library you're running against
*
* + initialises any libraries that VIPS is using, including GObject
* and the threading system, if neccessary
*
* + guesses where the VIPS data files are and sets up
* internationalisation --- see vips_guess_prefix()
*
* + creates the main vips types, including #VipsImage and friends
*
* + loads any plugins from $libdir/vips-x.y/, where x and y are the
* major and minor version numbers for this VIPS.
*
* + if your platform supports atexit(), VIPS_INIT() will ask for
* vips_shutdown() to be called on program exit
*
* Example:
*
* |[
* int main (int argc, char **argv)
* {
* if (VIPS_INIT (argv[0]))
* vips_error_exit ("unable to start VIPS");
*
* vips_shutdown ();
*
* return 0;
* }
* ]|
*
* See also: vips_shutdown(), vips_add_option_entries(), vips_version(),
* vips_guess_prefix(), vips_guess_libdir().
*
* Returns: 0 on success, -1 otherwise
*/
/* Load all plugins in a directory ... look for '.plg' suffix. Error if we had
* any probs.
*/
static int
vips_load_plugins( const char *fmt, ... )
{
va_list ap;
char dir_name[VIPS_PATH_MAX];
GDir *dir;
const char *name;
int result;
/* Silently succeed if we can't do modules.
*/
if( !g_module_supported() )
return( 0 );
va_start( ap, fmt );
(void) vips_vsnprintf( dir_name, VIPS_PATH_MAX - 1, fmt, ap );
va_end( ap );
#ifdef DEBUG
printf( "vips_load_plugins: searching \"%s\"\n", dir_name );
#endif /*DEBUG*/
if( !(dir = g_dir_open( dir_name, 0, NULL )) )
/* Silent success for dir not there.
*/
return( 0 );
result = 0;
while( (name = g_dir_read_name( dir )) )
if( vips_ispostfix( name, ".plg" ) ) {
char path[VIPS_PATH_MAX];
GModule *module;
vips_snprintf( path, VIPS_PATH_MAX - 1,
"%s" G_DIR_SEPARATOR_S "%s", dir_name, name );
#ifdef DEBUG
printf( "vips_load_plugins: loading \"%s\"\n", path );
#endif /*DEBUG*/
module = g_module_open( path, G_MODULE_BIND_LAZY );
if( !module ) {
vips_warn( "vips_init",
_( "unable to load \"%s\" -- %s" ),
path,
g_module_error() );
result = -1;
}
}
g_dir_close( dir );
return( result );
}
/**
* vips_init:
* @argv0: name of application
*
* This function starts up libvips, see VIPS_INIT().
*
* This function is for bindings which need to start up vips. C programs
* should use the VIPS_INIT() macro, which does some extra checks.
*
* See also: VIPS_INIT().
*
* Returns: 0 on success, -1 otherwise
*/
int
vips_init( const char *argv0 )
{
extern GType vips_system_get_type( void );
static gboolean started = FALSE;
static gboolean done = FALSE;
char *prgname;
const char *prefix;
const char *libdir;
char name[256];
/* Two stage done handling: 'done' means we've completed, 'started'
* means we're currently initialising. Use this to prevent recursive
* invocation.
*/
if( done )
/* Called more than once, we succeeded, just return OK.
*/
return( 0 );
if( started )
/* Recursive invocation, something has broken horribly.
* Hopefully the first init will handle it.
*/
return( 0 );
started = TRUE;
#ifdef OS_WIN32
/* Windows has a limit of 512 files open at once for the fopen() family
* of functions, and 2048 for the _open() family. This raises the limit
* of fopen() to the same level as _open().
*
* It will not go any higher than this, unfortunately.
*/
(void) _setmaxstdio( 2048 );
#endif /*OS_WIN32*/
#ifdef HAVE_TYPE_INIT
/* Before glib 2.36 you have to call this on startup.
*/
g_type_init();
#endif /*HAVE_TYPE_INIT*/
/* Older glibs need this.
*/
#ifndef HAVE_THREAD_NEW
if( !g_thread_supported() )
g_thread_init( NULL );
#endif
vips__threadpool_init();
vips__buffer_init();
/* This does an unsynchronised static hash table init on first call --
* we have to make sure we do this single-threaded. See:
* https://github.com/openslide/openslide/issues/161
*/
(void) g_get_language_names();
if( !vips__global_lock )
vips__global_lock = vips_g_mutex_new();
VIPS_SETSTR( vips__argv0, argv0 );
prgname = g_path_get_basename( argv0 );
g_set_prgname( prgname );
g_free( prgname );
vips__thread_profile_attach( "main" );
/* We can't do VIPS_GATE_START() until command-line processing
* happens, since vips__thread_profile may not be set yet. Call
* directly.
*/
vips__thread_gate_start( "init: main" );
vips__thread_gate_start( "init: startup" );
/* Try to discover our prefix.
*/
if( !(prefix = vips_guess_prefix( argv0, "VIPSHOME" )) ||
!(libdir = vips_guess_libdir( argv0, "VIPSHOME" )) )
return( -1 );
/* Get i18n .mo files from $VIPSHOME/share/locale/.
*/
vips_snprintf( name, 256,
"%s" G_DIR_SEPARATOR_S "share" G_DIR_SEPARATOR_S "locale",
prefix );
bindtextdomain( GETTEXT_PACKAGE, name );
bind_textdomain_codeset( GETTEXT_PACKAGE, "UTF-8" );
/* Default various settings from env.
*/
if( g_getenv( "VIPS_INFO" ) ||
g_getenv( "IM_INFO" ) )
vips_info_set( TRUE );
if( g_getenv( "VIPS_TRACE" ) )
vips_cache_set_trace( TRUE );
/* Register base vips types.
*/
(void) vips_image_get_type();
(void) vips_region_get_type();
vips__meta_init_types();
vips__interpolate_init();
im__format_init();
/* Start up operator cache.
*/
vips__cache_init();
/* Start up packages.
*/
(void) vips_system_get_type();
vips_arithmetic_operation_init();
vips_conversion_operation_init();
vips_create_operation_init();
vips_foreign_operation_init();
vips_resample_operation_init();
vips_colour_operation_init();
vips_histogram_operation_init();
vips_convolution_operation_init();
vips_freqfilt_operation_init();
vips_morphology_operation_init();
vips_draw_operation_init();
vips_mosaicing_operation_init();
/* Load any vips8 plugins from the vips libdir. Keep going, even if
* some plugins fail to load.
*/
(void) vips_load_plugins( "%s/vips-plugins-%d.%d",
libdir, VIPS_MAJOR_VERSION, VIPS_MINOR_VERSION );
/* Load up any vips7 plugins in the vips libdir. We don't error on
* failure, it's too annoying to have VIPS refuse to start because of
* a broken plugin.
*/
if( im_load_plugins( "%s/vips-%d.%d",
libdir, VIPS_MAJOR_VERSION, VIPS_MINOR_VERSION ) ) {
vips_warn( "vips_init", "%s", vips_error_buffer() );
vips_error_clear();
}
/* Also load from libdir. This is old and slightly broken behaviour
* :-( kept for back compat convenience.
*/
if( im_load_plugins( "%s", libdir ) ) {
vips_warn( "vips_init", "%s", vips_error_buffer() );
vips_error_clear();
}
/* Start up the buffer cache.
*/
vips__buffer_init();
/* Get the run-time compiler going.
*/
vips_vector_init();
#ifdef HAVE_GSF
/* Use this for structured file write.
*/
gsf_init();
#endif /*HAVE_GSF*/
/* Register vips_shutdown(). This may well not get called and many
* platforms don't support it anyway.
*/
#ifdef HAVE_ATEXIT
atexit( vips_shutdown );
#endif /*HAVE_ATEXIT*/
#ifdef DEBUG_LEAK
vips__image_pixels_quark =
g_quark_from_static_string( "vips-image-pixels" );
#endif /*DEBUG_LEAK*/
done = TRUE;
vips__thread_gate_stop( "init: startup" );
return( 0 );
}
/* Return the sizeof() various important data structures. These are checked
* against the headers used to build our caller by vips_init().
*
* We allow direct access to members of VipsImage and VipsRegion (mostly for
* reasons of history), so any change to a superclass of either of these
* objects will break our ABI.
*/
size_t
vips__get_sizeof_vipsobject( void )
{
return( sizeof( VipsObject ) );
}
/* Call this before vips stuff that uses stuff we need to have inited.
*/
void
vips_check_init( void )
{
/* Pass in a nonsense name for argv0 ... this init path is only here
* for old programs which are missing an vips_init() call. We need
* i18n set up before we can translate.
*/
if( vips_init( "vips" ) )
vips_error_clear();
}
static void
vips_leak( void )
{
char txt[1024];
VipsBuf buf = VIPS_BUF_STATIC( txt );
vips_object_print_all();
if( vips_tracked_get_allocs() ||
vips_tracked_get_mem() ||
vips_tracked_get_files() ) {
vips_buf_appendf( &buf, "memory: %d allocations, %zd bytes\n",
vips_tracked_get_allocs(), vips_tracked_get_mem() );
vips_buf_appendf( &buf, "files: %d open\n",
vips_tracked_get_files() );
}
vips_buf_appendf( &buf, "memory: high-water mark " );
vips_buf_append_size( &buf, vips_tracked_get_mem_highwater() );
vips_buf_appends( &buf, "\n" );
if( strlen( vips_error_buffer() ) > 0 )
vips_buf_appendf( &buf, "error buffer: %s",
vips_error_buffer() );
fprintf( stderr, "%s", vips_buf_all( &buf ) );
#ifdef DEBUG
vips_buffer_dump_all();
#endif /*DEBUG*/
}
/**
* vips_thread_shutdown:
*
* Free any thread-private data and flush any profiling information.
*
* This function needs to be called when a thread that has been using vips
* exits. It is called for you by vips_shutdown() and for any threads created
* by vips_g_thread_new().
*
* You will need to call it from threads created in
* other ways or there will be memory leaks. If you do not call it, vips
* will generate a warning message.
*
* It may be called many times, and you can continue using vips after
* calling it. Calling it too often will reduce performance.
*/
void
vips_thread_shutdown( void )
{
vips__buffer_shutdown();
vips__thread_profile_detach();
}
/**
* vips_shutdown:
*
* Call this to drop caches and close plugins. Run with "--vips-leak" to do
* a leak check too.
*
* You may call VIPS_INIT() many times and vips_shutdown() many times, but you
* must not call VIPS_INIT() after vips_shutdown(). In other words, you cannot
* stop and restart vips.
*/
void
vips_shutdown( void )
{
#ifdef DEBUG
printf( "vips_shutdown:\n" );
#endif /*DEBUG*/
vips_cache_drop_all();
im_close_plugins();
/* Mustn't run this more than once. Don't use the VIPS_GATE macro,
* since we don't for gate start.
*/
{
static gboolean done = FALSE;
if( !done )
vips__thread_gate_stop( "init: main" );
}
vips__render_shutdown();
vips_thread_shutdown();
vips__thread_profile_stop();
#ifdef HAVE_GSF
gsf_shutdown();
#endif /*HAVE_GSF*/
/* In dev releases, always show leaks. But not more than once, it's
* annoying.
*/
#ifndef DEBUG_LEAK
if( vips__leak )
#endif /*DEBUG_LEAK*/
{
static gboolean done = FALSE;
if( !done )
vips_leak();
done = TRUE;
}
}
const char *
vips__gettext( const char *msgid )
{
vips_check_init();
return( dgettext( GETTEXT_PACKAGE, msgid ) );
}
const char *
vips__ngettext( const char *msgid, const char *plural, unsigned long int n )
{
vips_check_init();
return( dngettext( GETTEXT_PACKAGE, msgid, plural, n ) );
}
static gboolean
vips_lib_version_cb( const gchar *option_name, const gchar *value,
gpointer data, GError **error )
{
printf( "libvips %s\n", VIPS_VERSION_STRING );
vips_shutdown();
exit( 0 );
}
static gboolean
vips_set_fatal_cb( const gchar *option_name, const gchar *value,
gpointer data, GError **error )
{
vips__fatal = 1;
/* Set masks for debugging ... stop on any problem.
*/
g_log_set_always_fatal(
G_LOG_FLAG_RECURSION |
G_LOG_FLAG_FATAL |
G_LOG_LEVEL_ERROR |
G_LOG_LEVEL_CRITICAL |
G_LOG_LEVEL_WARNING );
return( TRUE );
}
static GOptionEntry option_entries[] = {
{ "vips-info", 0, G_OPTION_FLAG_HIDDEN,
G_OPTION_ARG_NONE, &vips__info,
N_( "show informative messages" ), NULL },
{ "vips-fatal", 0, G_OPTION_FLAG_HIDDEN | G_OPTION_FLAG_NO_ARG,
G_OPTION_ARG_CALLBACK, (gpointer) &vips_set_fatal_cb,
N_( "abort on first error or warning" ), NULL },
{ "vips-concurrency", 0, 0,
G_OPTION_ARG_INT, &vips__concurrency,
N_( "evaluate with N concurrent threads" ), "N" },
{ "vips-tile-width", 0, G_OPTION_FLAG_HIDDEN,
G_OPTION_ARG_INT, &vips__tile_width,
N_( "set tile width to N (DEBUG)" ), "N" },
{ "vips-tile-height", 0, G_OPTION_FLAG_HIDDEN,
G_OPTION_ARG_INT, &vips__tile_height,
N_( "set tile height to N (DEBUG)" ), "N" },
{ "vips-thinstrip-height", 0, G_OPTION_FLAG_HIDDEN,
G_OPTION_ARG_INT, &vips__thinstrip_height,
N_( "set thinstrip height to N (DEBUG)" ), "N" },
{ "vips-fatstrip-height", 0, G_OPTION_FLAG_HIDDEN,
G_OPTION_ARG_INT, &vips__fatstrip_height,
N_( "set fatstrip height to N (DEBUG)" ), "N" },
{ "vips-progress", 0, 0,
G_OPTION_ARG_NONE, &vips__progress,
N_( "show progress feedback" ), NULL },
{ "vips-leak", 0, 0,
G_OPTION_ARG_NONE, &vips__leak,
N_( "leak-check on exit" ), NULL },
{ "vips-profile", 0, 0,
G_OPTION_ARG_NONE, &vips__thread_profile,
N_( "profile and dump timing on exit" ), NULL },
{ "vips-disc-threshold", 0, 0,
G_OPTION_ARG_STRING, &vips__disc_threshold,
N_( "images larger than N are decompressed to disc" ), "N" },
{ "vips-novector", 0, G_OPTION_FLAG_REVERSE,
G_OPTION_ARG_NONE, &vips__vector_enabled,
N_( "disable vectorised versions of operations" ), NULL },
{ "vips-cache-max", 0, 0,
G_OPTION_ARG_STRING, &vips__cache_max,
N_( "cache at most N operations" ), "N" },
{ "vips-cache-max-memory", 0, 0,
G_OPTION_ARG_STRING, &vips__cache_max_mem,
N_( "cache at most N bytes in memory" ), "N" },
{ "vips-cache-max-files", 0, 0,
G_OPTION_ARG_STRING, &vips__cache_max_files,
N_( "allow at most N open files" ), "N" },
{ "vips-cache-trace", 0, 0,
G_OPTION_ARG_NONE, &vips__cache_trace,
N_( "trace operation cache" ), NULL },
{ "vips-cache-dump", 0, 0,
G_OPTION_ARG_NONE, &vips__cache_dump,
N_( "dump operation cache on exit" ), NULL },
{ "vips-version", 0, G_OPTION_FLAG_NO_ARG,
G_OPTION_ARG_CALLBACK, (gpointer) &vips_lib_version_cb,
N_( "print libvips version" ), NULL },
{ NULL }
};
/**
* vips_add_option_entries:
* @option_group: group to add to
*
* Add the standard vips %GOptionEntry to a %GOptionGroup.
*
* See also: g_option_group_new().
*/
void
vips_add_option_entries( GOptionGroup *option_group )
{
g_option_group_add_entries( option_group, option_entries );
}
/* Find the prefix part of a dir ... name is the name of this prog from argv0.
*
* dir name guess prefix
*
* /home/john/vips-7.6.4/bin/vips-7.6 vips-7.6 /home/john/vips-7.6.4
* /usr/local/bin/ip ip /usr/local
*
* all other forms ... return NULL.
*/
static char *
extract_prefix( const char *dir, const char *name )
{
char edir[VIPS_PATH_MAX];
char vname[VIPS_PATH_MAX];
int i;
#ifdef DEBUG
printf( "extract_prefix: trying for dir = \"%s\", name = \"%s\"\n",
dir, name );
#endif /*DEBUG*/
/* Is dir relative? Prefix with cwd.
*/
if( !g_path_is_absolute( dir ) ) {
char *cwd;
cwd = g_get_current_dir();
vips_snprintf( edir, VIPS_PATH_MAX,
"%s" G_DIR_SEPARATOR_S "%s", cwd, dir );
g_free( cwd );
}
else {
vips_strncpy( edir, dir, VIPS_PATH_MAX );
}
/* Chop off the trailing prog name, plus the trailing
* G_DIR_SEPARATOR_S.
*/
if( !vips_ispostfix( edir, name ) )
return( NULL );
vips_strncpy( vname, edir, VIPS_PATH_MAX );
vname[strlen( edir ) - strlen( name ) - 1] = '\0';
/* Remove any "/./", any trailing "/.", any trailing "/".
*/
for( i = 0; i < (int) strlen( vname ); i++ )
if( vips_isprefix( G_DIR_SEPARATOR_S "." G_DIR_SEPARATOR_S,
vname + i ) )
memcpy( vname + i, vname + i + 2,
strlen( vname + i + 2 ) + 1 );
if( vips_ispostfix( vname, G_DIR_SEPARATOR_S "." ) )
vname[strlen( vname ) - 2] = '\0';
if( vips_ispostfix( vname, G_DIR_SEPARATOR_S ) )
vname[strlen( vname ) - 1] = '\0';
#ifdef DEBUG
printf( "extract_prefix: canonicalised path = \"%s\"\n", vname );
#endif /*DEBUG*/
/* Ought to be a "/bin" at the end now.
*/
if( !vips_ispostfix( vname, G_DIR_SEPARATOR_S "bin" ) )
return( NULL );
vname[strlen( vname ) - strlen( G_DIR_SEPARATOR_S "bin" )] = '\0';
#ifdef DEBUG
printf( "extract_prefix: found \"%s\"\n", vname );
#endif /*DEBUG*/
return( vips_strdup( NULL, vname ) );
}
/* Search a path for a file ... we overwrite the PATH string passed in.
*/
static char *
scan_path( char *path, const char *name )
{
char *p, *q;
char *prefix;
for( p = path;
(q = vips_break_token( p, G_SEARCHPATH_SEPARATOR_S )); p = q ) {
char str[VIPS_PATH_MAX];
/* Form complete path.
*/
vips_snprintf( str, VIPS_PATH_MAX,
"%s" G_DIR_SEPARATOR_S "%s", p, name );
#ifdef DEBUG
printf( "scan_path: looking in \"%s\" for \"%s\"\n",
p, name );
#endif /*DEBUG*/
if( vips_existsf( "%s", str ) &&
(prefix = extract_prefix( str, name )) ) {
return( prefix );
}
}
return( NULL );
}
/* Look for a file along PATH. If we find it, look for an enclosing prefix.
*/
static char *
find_file( const char *name )
{
const char *path = g_getenv( "PATH" );
char *prefix;
char full_path[VIPS_PATH_MAX];
if( !path )
return( NULL );
#ifdef DEBUG
printf( "vips_guess_prefix: g_getenv( \"PATH\" ) == \"%s\"\n", path );
#endif /*DEBUG*/
#ifdef OS_WIN32
{
char *dir;
/* Windows always searches '.' first, so prepend cwd to path.
*/
dir = g_get_current_dir();
vips_snprintf( full_path, VIPS_PATH_MAX,
"%s" G_SEARCHPATH_SEPARATOR_S "%s", dir, path );
g_free( dir );
}
#else /*!OS_WIN32*/
vips_strncpy( full_path, path, VIPS_PATH_MAX );
#endif /*OS_WIN32*/
if( (prefix = scan_path( full_path, name )) )
return( prefix );
return( NULL );
}
/* Guess a value for the install PREFIX.
*/
static const char *
guess_prefix( const char *argv0, const char *name )
{
char *prefix;
/* Try to guess from argv0.
*/
if( argv0 ) {
if( g_path_is_absolute( argv0 ) ) {
/* Must point to our executable.
*/
if( (prefix = extract_prefix( argv0, name )) ) {
#ifdef DEBUG
printf( "vips_guess_prefix: found \"%s\" from "
"argv0\n", prefix );
#endif /*DEBUG*/
return( prefix );
}
}
/* Look along path for name.
*/
if( (prefix = find_file( name )) ) {
#ifdef DEBUG
printf( "vips_guess_prefix: found \"%s\" from "
"PATH\n", prefix );
#endif /*DEBUG*/
return( prefix );
}
}
#ifdef HAVE_REALPATH
/* Try to guess from cwd. Only if this is a relative path, though. No
* realpath on winders, but fortunately it seems to always generate
* a full path in argv[0].
*/
if( !g_path_is_absolute( argv0 ) ) {
char full_path[VIPS_PATH_MAX];
char *resolved;
char *dir;
dir = g_get_current_dir();
vips_snprintf( full_path, VIPS_PATH_MAX,
"%s" G_DIR_SEPARATOR_S "%s", dir, argv0 );
g_free( dir );
if( (resolved = realpath( full_path, NULL )) ) {
prefix = extract_prefix( resolved, name );
free( resolved );
if( prefix ) {
#ifdef DEBUG
printf( "vips_guess_prefix: found \"%s\" "
"from cwd\n", prefix );
#endif /*DEBUG*/
return( prefix );
}
}
}
#endif /*HAVE_REALPATH*/
/* Fall back to the configure-time prefix.
*/
return( VIPS_PREFIX );
}
/**
* vips_guess_prefix:
* @argv0: program name (typically argv[0])
* @env_name: save prefix in this environment variable
*
* vips_guess_prefix() tries to guess the install directory. You should pass
* in the value of argv[0] (the name your program was run as) as a clue to
* help it out, plus the name of the environment variable you let the user
* override your package install area with (eg. "VIPSHOME").
*
* On success, vips_guess_prefix() returns the prefix it discovered, and as a
* side effect, sets the environment variable (if it's not set).
*
* Don't free the return string!
*
* See also: vips_guess_libdir().
*
* Returns: (transfer none): the install prefix as a static string, do not free.
*/
const char *
vips_guess_prefix( const char *argv0, const char *env_name )
{
const char *prefix;
char *basename;
char name[VIPS_PATH_MAX];
/* Already set?
*/
if( (prefix = g_getenv( env_name )) ) {
#ifdef DEBUG
printf( "vips_guess_prefix: found \"%s\" in environment\n",
prefix );
#endif /*DEBUG*/
return( prefix );
}
/* Get the program name from argv0.
*/
basename = g_path_get_basename( argv0 );
/* Add the exe suffix, if it's missing.
*/
if( strlen( VIPS_EXEEXT ) > 0 ) {
const char *olds[] = { VIPS_EXEEXT };
vips__change_suffix( basename, name,
VIPS_PATH_MAX, VIPS_EXEEXT, olds, 1 );
}
else
vips_strncpy( name, basename, VIPS_PATH_MAX );
g_free( basename );
#ifdef DEBUG
printf( "vips_guess_prefix: argv0 = %s\n", argv0 );
printf( "vips_guess_prefix: name = %s\n", name );
#endif /*DEBUG*/
prefix = guess_prefix( argv0, name );
g_setenv( env_name, prefix, TRUE );
return( prefix );
}
/**
* vips_guess_libdir:
* @argv0: program name (typically argv[0])
* @env_name: save prefix in this environment variable
*
* vips_guess_libdir() tries to guess the install directory (usually the
* configure libdir, or $prefix/lib). You should pass
* in the value of argv[0] (the name your program was run as) as a clue to
* help it out, plus the name of the environment variable you let the user
* override your package install area with (eg. "VIPSHOME").
*
* On success, vips_guess_libdir() returns the libdir it discovered, and as a
* side effect, sets the prefix environment variable (if it's not set).
*
* Don't free the return string!
*
* See also: vips_guess_prefix().
*
* Returns: (transfer none): the libdir as a static string, do not free.
*/
const char *
vips_guess_libdir( const char *argv0, const char *env_name )
{
const char *prefix = vips_guess_prefix( argv0, env_name );
static char *libdir = NULL;
if( libdir )
return( libdir );
/* Have we been moved since configure? If not, use the configure-time
* libdir.
*/
if( strcmp( prefix, VIPS_PREFIX ) == 0 )
libdir = VIPS_LIBDIR;
else
libdir = g_strdup_printf( "%s/lib", prefix );
#ifdef DEBUG
printf( "vips_guess_libdir: VIPS_PREFIX = %s\n", VIPS_PREFIX );
printf( "vips_guess_libdir: VIPS_LIBDIR = %s\n", VIPS_LIBDIR );
printf( "vips_guess_libdir: prefix = %s\n", prefix );
printf( "vips_guess_libdir: libdir = %s\n", libdir );
#endif /*DEBUG*/
return( libdir );
}
/**
* vips_version_string:
*
* Get the VIPS version as a static string, including a build date and time.
* Do not free.
*
* Returns: (transfer none): a static version string
*/
const char *
vips_version_string( void )
{
return( VIPS_VERSION_STRING );
}
/**
* vips_version:
* @flag: which field of the version to get
*
* Get the major, minor or micro library version, with @flag values 0, 1 and
* 2.
*
* Returns: library version number
*/
int
vips_version( int flag )
{
switch( flag ) {
case 0:
return( VIPS_MAJOR_VERSION );
case 1:
return( VIPS_MINOR_VERSION );
case 2:
return( VIPS_MICRO_VERSION );
default:
vips_error( "vips_version", "%s", _( "flag not 0, 1, 2" ) );
return( -1 );
}
}
/**
* vips_leak_set:
* @leak: turn leak checking on or off
*
* Turn on or off vips leak checking. See also --vips-leak and
* vips_add_option_entries().
*
* You should call this very early in your program.
*/
void
vips_leak_set( gboolean leak )
{
vips__leak = leak;
}
|