ARROW-3630: [Plasma][GLib] Add GLib bindings of Plasma

.travis.yml

@@ -230,6 +230,7 @@ matrix:
     - ARROW_TRAVIS_GANDIVA=1
     - ARROW_TRAVIS_USE_VENDORED_BOOST=1
     - ARROW_TRAVIS_PARQUET=1
+    - ARROW_TRAVIS_PLASMA=1
     - BUILD_TORCH_EXAMPLE=no
     - MATRIX_EVAL="CC=gcc-4.9 && CXX=g++-4.9"
     before_script:

c_glib/Makefile.am

@@ -22,6 +22,7 @@ SUBDIRS =					\
 	arrow-gpu-glib				\
 	gandiva-glib				\
 	parquet-glib				\
+	plasma-glib				\
 	doc					\
 	example					\
 	tool

c_glib/configure.ac

@@ -142,6 +142,10 @@ if test "x$GARROW_ARROW_CPP_BUILD_DIR" = "x"; then
                     [parquet],
                     [HAVE_PARQUET=yes],
                     [HAVE_PARQUET=no])
+  PKG_CHECK_MODULES([PLASMA],
+                    [plasma],
+                    [HAVE_PLASMA=yes],
+                    [HAVE_PLASMA=no])
 else
   USE_ARROW_BUILD_DIR=yes
 
@@ -196,6 +200,17 @@ else
   fi
   AC_SUBST(PARQUET_CFLAGS)
   AC_SUBST(PARQUET_LIBS)
+
+  PLASMA_CFLAGS=""
+  if test -f "${GARROW_ARROW_CPP_BUILD_DIR}/src/plasma/plasma.pc"; then
+    HAVE_PLASMA=yes
+    PLASMA_LIBS="-lplasma"
+  else
+    HAVE_PLASMA=no
+    PLASMA_LIBS=""
+  fi
+  AC_SUBST(PLASMA_CFLAGS)
+  AC_SUBST(PLASMA_LIBS)
 fi
 
 AM_CONDITIONAL([USE_ARROW_BUILD_DIR],
@@ -211,14 +226,19 @@ if test "$HAVE_ARROW_GPU" = "yes"; then
   AC_DEFINE(HAVE_ARROW_GPU, [1], [Define to 1 if Apache Arrow supports GPU.])
 fi
 
+AM_CONDITIONAL([HAVE_GANDIVA], [test "$HAVE_GANDIVA" = "yes"])
+if test "$HAVE_GANDIVA" = "yes"; then
+  AC_DEFINE(HAVE_GANDIVA, [1], [Define to 1 if Gandiva exists.])
+fi
+
 AM_CONDITIONAL([HAVE_PARQUET], [test "$HAVE_PARQUET" = "yes"])
 if test "$HAVE_PARQUET" = "yes"; then
   AC_DEFINE(HAVE_PARQUET, [1], [Define to 1 if Apache Parquet exists.])
 fi
 
-AM_CONDITIONAL([HAVE_GANDIVA], [test "$HAVE_GANDIVA" = "yes"])
-if test "$HAVE_GANDIVA" = "yes"; then
-  AC_DEFINE(HAVE_GANDIVA, [1], [Define to 1 if Gandiva exists.])
+AM_CONDITIONAL([HAVE_PLASMA], [test "$HAVE_PLASMA" = "yes"])
+if test "$HAVE_PLASMA" = "yes"; then
+  AC_DEFINE(HAVE_PLASMA, [1], [Define to 1 if Plasma exists.])
 fi
 
 exampledir="\$(datadir)/arrow-glib/example"
@@ -236,13 +256,17 @@ AC_CONFIG_FILES([
   gandiva-glib/gandiva-glib.pc
   parquet-glib/Makefile
   parquet-glib/parquet-glib.pc
+  plasma-glib/Makefile
+  plasma-glib/plasma-glib.pc
   doc/Makefile
   doc/arrow-glib/Makefile
   doc/arrow-glib/entities.xml
   doc/gandiva-glib/Makefile
   doc/gandiva-glib/entities.xml
   doc/parquet-glib/Makefile
   doc/parquet-glib/entities.xml
+  doc/plasma-glib/Makefile
+  doc/plasma-glib/entities.xml
   example/Makefile
   example/lua/Makefile
   tool/Makefile

c_glib/doc/Makefile.am

@@ -18,4 +18,5 @@
 SUBDIRS =					\
 	arrow-glib				\
 	gandiva-glib				\
-	parquet-glib
+	parquet-glib				\
+	plasma-glib

c_glib/doc/plasma-glib/Makefile.am

@@ -0,0 +1,69 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+if HAVE_PLASMA
+DOC_MODULE = plasma-glib
+
+DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
+
+DOC_SOURCE_DIR =				\
+	$(top_srcdir)/plasma-glib		\
+	$(top_builddir)/plasma-glib
+
+SCAN_OPTIONS =						\
+	--deprecated-guards="GPLASMA_DISABLE_DEPRECATED"
+
+MKDB_OPTIONS =					\
+	--name-space=gplasma			\
+	--source-suffixes="c,cpp,h"
+
+HFILE_GLOB =					\
+	$(top_srcdir)/plasma-glib/*.h
+
+IGNORE_HFILES =
+
+CFILE_GLOB =					\
+	$(top_srcdir)/plasma-glib/*.cpp
+
+AM_CPPFLAGS =					\
+	-I$(top_builddir)			\
+	-I$(top_srcdir)
+
+AM_CFLAGS =					\
+	$(GLIB_CFLAGS)				\
+	$(ARROW_CFLAGS)				\
+	$(PLASMA_CFLAGS)
+
+GTKDOC_LIBS =						\
+	$(top_builddir)/arrow-glib/libarrow-glib.la	\
+	$(top_builddir)/plasma-glib/libplasma-glib.la
+
+include $(top_srcdir)/gtk-doc.make
+
+CLEANFILES +=					\
+	$(DOC_MODULE)-decl-list.txt		\
+	$(DOC_MODULE)-decl.txt			\
+	$(DOC_MODULE)-overrides.txt		\
+	$(DOC_MODULE)-sections.txt		\
+	$(DOC_MODULE).types
+else
+EXTRA_DIST =
+endif
+
+EXTRA_DIST +=					\
+	entities.xml.in				\
+	meson.build

c_glib/doc/plasma-glib/entities.xml.in

@@ -0,0 +1,24 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
+<!ENTITY package "@PACKAGE@">
+<!ENTITY package_bugreport "@PACKAGE_BUGREPORT@">
+<!ENTITY package_name "@PACKAGE_NAME@">
+<!ENTITY package_string "@PACKAGE_STRING@">
+<!ENTITY package_url "@PACKAGE_URL@">
+<!ENTITY package_version "@PACKAGE_VERSION@">

c_glib/doc/plasma-glib/meson.build

@@ -0,0 +1,82 @@
+# -*- indent-tabs-mode: nil -*-
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+project_name = 'plasma-glib'
+entities_conf = configuration_data()
+entities_conf.set('PACKAGE', project_name)
+entities_conf.set('PACKAGE_BUGREPORT',
+                  'https://issues.apache.org/jira/browse/ARROW')
+entities_conf.set('PACKAGE_NAME', project_name)
+entities_conf.set('PACKAGE_STRING',
+                  ' '.join([project_name, version]))
+entities_conf.set('PACKAGE_URL', 'https://arrow.apache.org/')
+entities_conf.set('PACKAGE_VERSION', version)
+configure_file(input: 'entities.xml.in',
+               output: 'entities.xml',
+               configuration: entities_conf)
+
+private_headers = [
+]
+
+content_files = [
+]
+
+html_images = [
+]
+
+glib_prefix = dependency('glib-2.0').get_pkgconfig_variable('prefix')
+glib_doc_path = join_paths(glib_prefix, 'share', 'gtk-doc', 'html')
+arrow_glib_doc_path = join_paths(data_dir,
+                                 'gtk-doc',
+                                 'html',
+                                 meson.project_name())
+doc_path = join_paths(data_dir, project_name, 'gtk-doc', 'html')
+
+source_directories = [
+  join_paths(meson.source_root(), 'plasma-glib'),
+  join_paths(meson.build_root(), 'plasma-glib'),
+]
+dependencies = [
+  arrow_glib,
+  plasma_glib,
+]
+ignore_headers = []
+gnome.gtkdoc(project_name,
+             main_xml: project_name + '-docs.xml',
+             src_dir: source_directories,
+             dependencies: dependencies,
+             ignore_headers: ignore_headers,
+             gobject_typesfile: project_name + '.types',
+             scan_args: [
+               '--rebuild-types',
+               '--deprecated-guards=GPLASMA_DISABLE_DEPRECATED',
+             ],
+             mkdb_args: [
+               '--output-format=xml',
+               '--name-space=gplasma',
+               '--source-suffixes=c,cpp,h',
+             ],
+             fixxref_args: [
+               '--html-dir=' + doc_path,
+               '--extra-dir=' + join_paths(glib_doc_path, 'glib'),
+               '--extra-dir=' + join_paths(glib_doc_path, 'gobject'),
+               '--extra-dir=' + arrow_glib_doc_path,
+             ],
+             html_assets: html_images,
+             install: true)

c_glib/doc/plasma-glib/plasma-glib-docs.xml

@@ -0,0 +1,64 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+  <!ENTITY % gtkdocentities SYSTEM "entities.xml">
+  %gtkdocentities;
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>&package_name; Reference Manual</title>
+    <releaseinfo>
+      for &package_string;.
+      <!--
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://[SERVER]/&package_name;/">http://[SERVER]/&package_name;/</ulink>.
+      -->
+    </releaseinfo>
+  </bookinfo>
+
+  <part id="plasma-client">
+    <title>PlasmaClient</title>
+    <chapter id="client">
+      <title>Client</title>
+      <xi:include href="xml/client.xml"/>
+    </chapter>
+  </part>
+
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+    <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated API</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="api-index-0-12-0" role="0.12.0">
+    <title>Index of new symbols in 0.12.0</title>
+    <xi:include href="xml/api-index-0.12.0.xml"><xi:fallback /></xi:include>
+  </index>
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>

c_glib/meson.build

@@ -67,6 +67,7 @@ if arrow_cpp_build_lib_dir == ''
   arrow_gpu = dependency('arrow-gpu', required: false)
   gandiva = dependency('gandiva', required: false)
   parquet = dependency('parquet', required: false)
+  plasma = dependency('plasma', required: false)
 else
   base_include_directories += [
     include_directories(join_paths(arrow_cpp_build_dir, 'src')),
@@ -97,6 +98,9 @@ main(void)
   parquet = cpp_compiler.find_library('parquet',
                                       dirs: [arrow_cpp_build_lib_dir],
                                       required: false)
+  plasma = cpp_compiler.find_library('plasma',
+                                      dirs: [arrow_cpp_build_lib_dir],
+                                      required: false)
 endif
 
 subdir('arrow-glib')
@@ -109,6 +113,9 @@ endif
 if parquet.found()
   subdir('parquet-glib')
 endif
+if plasma.found()
+  subdir('plasma-glib')
+endif
 subdir('example')
 
 if get_option('gtk_doc')
@@ -119,6 +126,9 @@ if get_option('gtk_doc')
   if parquet.found()
     subdir('doc/parquet-glib')
   endif
+  if plasma.found()
+    subdir('doc/plasma-glib')
+  endif
 endif
 
 run_test = find_program('test/run-test.sh')
@@ -129,4 +139,5 @@ test('unit test',
        'ARROW_GPU_GLIB_TYPELIB_DIR=@0@/arrow-gpu-glib'.format(meson.build_root()),
        'GANDIVA_GLIB_TYPELIB_DIR=@0@/gandiva-glib'.format(meson.build_root()),
        'PARQUET_GLIB_TYPELIB_DIR=@0@/parquet-glib'.format(meson.build_root()),
+       'PARQUET_GLIB_TYPELIB_DIR=@0@/plasma-glib'.format(meson.build_root()),
      ])