git.roojs.org Git - gnome.gobject-introspection/blob - Makefile.introspection

   1 # -*- Mode: make -*-
   2 # Copyright 2009 Johan Dahlin
   3 #
   4 # This file is free software; the author(s) gives unlimited
   5 # permission to copy and/or distribute it, with or without
   6 # modifications, as long as this notice is preserved.
   7 #
   8 # * Input variables:
   9 #
  10 #   INTROSPECTION_GIRS - List of GIRS that should be generated
  11 #   INTROSPECTION_SCANNER - Command to invoke scanner, normally set by
  12 #      GOBJECT_INTROSPECTION_REQUIRE/CHECK() in introspection.m4
  13 #   INTROSPECTION_SCANNER_ARGS - Additional args to pass in to the scanner
  14 #   INTROSPECTION_COMPILER - Command to invoke compiler, normally set by
  15 #      GOBJECT_INTROSPECTION_REQUIRE/CHECK() in introspection.m4
  16 #   INTROSPECTION_COMPILER_ARGS - Additional args to pass in to the compiler
  17 #
  18 # * Simple tutorial
  19 #
  20 # Add this to configure.ac:
  21 #   -Wno-portability to AM_INIT_AUTOMAKE
  22 #   GOBJECT_INTROSPECTION_CHECK([0.6.7])
  23 #
  24 # Add this to Makefile.am where your library/program is built:
  25 #   include $(INTROSPECTION_MAKEFILE)
  26 #   INTROSPECTION_GIRS = YourLib-1.0.gir
  27 #   YourLib_1_0_gir_NAMESPACE = YourLib
  28 #   YourLib_1_0_gir_VERSION = 1.0
  29 #   YourLib_1_0_gir_LIBS = libyourlib.la
  30 #   YourLib_1_0_gir_FILES = $(libyourlib_1_0_SOURCES)
  31 #   girdir = $(INTROSPECTION_GIRDIR)
  32 #   dist_gir_DATA = YourLib-1.0.gir
  33 #   typelibdir = $(INTROSPECTION_TYPELIBDIR)
  34 #   typelib_DATA = YourLib-1.0.typelib
  35 #   CLEANFILES = $(dist_gir_DATA) $(typelib_DATA)
  36 #
  37
  38 # Make sure the required variables are set, these should under normal
  39 # circumstances come from introspection.m4
  40 $(if $(INTROSPECTION_SCANNER),,$(error Need to define INTROSPECTION_SCANNER))
  41 $(if $(INTROSPECTION_COMPILER),,$(error Need to define INTROSPECTION_COMPILER))
  42
  43 # Private functions
  44
  45 ## Transform the gir filename to something which can reference through a variable
  46 ## without automake/make complaining, eg Gtk-2.0.gir -> Gtk_2_0_gir
  47 _gir_name = $(subst -,_,$(subst .,_,$(1)))
  48
  49 # Namespace and Version is either fetched from the gir filename
  50 # or the _NAMESPACE/_VERSION variable combo
  51 _gir_namespace = $(or $($(_gir_name)_NAMESPACE),$(firstword $(subst -, ,$(1))))
  52 _gir_version = $(or $($(_gir_name)_VERSION),$(lastword $(subst -, ,$(1:.gir=))))
  53
  54 # _PROGRAM is an optional variable which needs it's own --program argument
  55 _gir_program = $(if $($(_gir_name)_PROGRAM),--program=$($(_gir_name)_PROGRAM))
  56
  57 # Variables which provides a list of things
  58 _gir_libraries = $(foreach lib,$($(_gir_name)_LIBS),--library=$(lib))
  59 _gir_packages = $(foreach pkg,$($(_gir_name)_PACKAGES),--pkg=$(pkg))
  60 _gir_includes = $(foreach include,$($(_gir_name)_INCLUDES),--include=$(include))
  61
  62 # Reuse the LIBTOOL variable from by automake if it's set
  63 _gir_libtool = $(if $(LIBTOOL),--libtool="$(LIBTOOL)")
  64
  65 # Macros for AM_SILENT_RULES prettiness
  66 _gir_verbosity = $(if $(AM_DEFAULT_VERBOSITY),$(AM_DEFAULT_VERBOSITY),1)
  67
  68 _gir_silent_scanner = $(_gir_silent_scanner_$(V))
  69 _gir_silent_scanner_ = $(_gir_silent_scanner_$(_gir_verbosity))
  70 _gir_silent_scanner_0 = @echo "  GISCAN $(1)";
  71
  72 _gir_silent_compiler = $(_gir_silent_compiler_$(V))
  73 _gir_silent_compiler_ = $(_gir_silent_compiler_$(_gir_verbosity))
  74 _gir_silent_compiler_0 = @echo "  GICOMP $(1)";
  75
  76 #
  77 # Creates a GIR by scanning C headers/sources
  78 # $(1) - Name of the gir file (output)
  79 #
  80 # If output is Gtk-2.0.gir then you should name the variables like
  81 # Gtk_2_0_gir_NAMESPACE, Gtk_2_0_gir_VERSION etc.
  82 # Required variables:
  83 # FILES - C sources and headers which should be scanned
  84 #
  85 # One of these variables are required:
  86 # LIBS - Library where the symbol represented in the gir can be found
  87 # PROGRAM - Program where the symbol represented in the gir can be found
  88 #
  89 # Optional variables
  90 # NAMESPACE - Namespace of the gir, first letter capital,
  91 #   rest should be lower case, for instance: 'Gtk', 'Clutter', 'ClutterGtk'.
  92 #   If not present the namespace will be fetched from the gir filename,
  93 #   the part before the first dash. For 'Gtk-2.0', namespace will be 'Gtk'.
  94 # VERSION - Version of the gir, if not present, will be fetched from gir
  95 # filename, the part after the first dash. For 'Gtk-2.0', version will be '2.0'.
  96 # LIBTOOL - Command to invoke libtool, usually set by automake
  97 # SCANNERFLAGS - Flags to pass in to the scanner, see g-ir-scanner(1) for a list
  98 # CFLAGS - Flags to pass in to the parser when scanning headers
  99 # PACKAGES - list of pkg-config names which cflags are required to parse
 100 #   the headers of this gir
 101 # INCLUDES - Gir files to include without the .gir suffix, for instance
 102 #   GLib-2.0, Gtk-2.0. This is needed for all libraries which you depend on that
 103 #   provides introspection information.
 104 #
 105
 106 define introspection-scanner
 107
 108 # Basic sanity check, to make sure required variables are set
 109 $(if $($(_gir_name)_FILES),,$(error Need to define $(_gir_name)_FILES))
 110 $(if $(or $($(_gir_name)_LIBS),
 111           $($(_gir_name)_PROGRAM)),,
 112     $(error Need to define $(_gir_name)_LIBS or $(_gir_name)_PROGRAM))
 113
 114 # Only dependencies we know are actually filenames goes into _FILES, make
 115 # sure these are built before running the scanner. Libraries and programs
 116 # needs to be added manually.
 117 $(1): $$($(_gir_name)_FILES) $(INTROSPECTION_PARSER)
 118         $(_gir_silent_scanner) $(INTROSPECTION_SCANNER) $(INTROSPECTION_SCANNER_ARGS) \
 119           --namespace=$(_gir_namespace) \
 120           --nsversion=$(_gir_version) \
 121           $(_gir_libtool) \
 122           $(_gir_program) \
 123           $(_gir_libraries) \
 124           $(_gir_packages) \
 125           $(_gir_includes) \
 126           $($(_gir_name)_SCANNERFLAGS) \
 127           $($(_gir_name)_CFLAGS) \
 128           $($(_gir_name)_FILES) \
 129           --output $(1)
 130 endef
 131
 132 $(foreach gir,$(INTROSPECTION_GIRS),$(eval $(call introspection-scanner,$(gir))))
 133
 134 #
 135 # Compiles a gir into a typelib
 136 # $(1): gir filename (input)
 137 # $(2): typelib filename (output)
 138 #
 139 define introspection-compiler
 140 $(_gir_silent_compiler) $(INTROSPECTION_COMPILER) $(INTROSPECTION_COMPILER_ARGS) --includedir=. $(1) -o $(2)
 141 endef
 142
 143 # Simple rule to compile a typelib.
 144 %.typelib: %.gir $(INTROSPECTION_COMPILER)
 145         $(call introspection-compiler,$<,$@)