← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to config/register_plugins.py

  • Committer: Brian Aker
  • Date: 2009-11-18 06:11:12 UTC
  • mfrom: (1220.1.10 staging)
  • Revision ID: brian@gaz-20091118061112-tyf4qrfr5v7i946b
Monty + Brian Merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
config/register_plugins.py
18
18
 
19
19
# Find plugins in the tree and add them to the build system 
20
20
 
21
 
import os, ConfigParser, sys
 
21
import ConfigParser, os, sys
22
22
 
23
23
top_srcdir='.'
24
24
top_builddir='.'
25
25
plugin_ini_fname='plugin.ini'
26
26
plugin_list=[]
27
 
autogen_header="This file is generated, re-run %s to rebuild\n" % sys.argv[0]
 
27
plugin_am_file=None
 
28
plugin_ac_file=None
28
29
 
29
30
class ChangeProtectedFile(object):
30
31
 
31
32
  def __init__(self, fname):
 
33
    self.bogus_file= False
32
34
    self.real_fname= fname
33
35
    self.new_fname= "%s.new" % fname
34
 
    self.new_file= open(self.new_fname,'w')
 
36
    try:
 
37
      self.new_file= open(self.new_fname,'w+')
 
38
    except IOError:
 
39
      self.bogus_file= True
35
40
 
36
41
  def write(self, text):
37
 
    self.new_file.write(text)
 
42
    if not self.bogus_file:
 
43
      self.new_file.write(text)
38
44
 
39
45
  # We've written all of this out into .new files, now we only copy them
40
46
  # over the old ones if they are different, so that we don't cause 
41
47
  # unnecessary recompiles
42
48
  def close(self):
 
49
    """Return True if the file had changed."""
 
50
    if self.bogus_file:
 
51
      return
 
52
    self.new_file.seek(0)
 
53
    new_content = self.new_file.read()
43
54
    self.new_file.close()
44
 
    if os.system('diff %s %s >/dev/null 2>&1' % (self.new_fname,self.real_fname)):
45
 
      try:
 
55
    try:
 
56
        old_file = file(self.real_fname, 'r')
 
57
        old_content = old_file.read()
 
58
        old_file.close()
 
59
    except IOError:
 
60
        old_content = None
 
61
    if new_content != old_content:
 
62
      if old_content != None:
46
63
        os.unlink(self.real_fname)
47
 
      except:
48
 
        pass
49
64
      os.rename(self.new_fname, self.real_fname)
50
 
    try:
51
 
      os.unlink(self.new_fname)
52
 
    except:
53
 
      pass
54
 
 
55
 
if len(sys.argv)>1:
56
 
  top_srcdir=sys.argv[1]
57
 
  top_builddir=top_srcdir
58
 
if len(sys.argv)>2:
59
 
  top_builddir=sys.argv[2]
60
 
 
61
 
plugin_ac=ChangeProtectedFile(os.path.join(top_builddir,'config','plugin.ac'))
62
 
plugin_am=ChangeProtectedFile(os.path.join(top_srcdir,'config','plugin.am'))
63
 
 
64
 
plugin_ac.write("dnl %s" % autogen_header)
65
 
plugin_am.write("# %s" % autogen_header)
66
 
plugin_am.write("PANDORA_DYNAMIC_LDADDS=\n")
67
 
 
68
 
def accumulate_plugins(arg, dirname, fnames):
69
 
  if plugin_ini_fname in fnames:
70
 
    arg.append(dirname)
71
 
 
72
 
 
73
 
os.path.walk(os.path.join(top_srcdir,"plugin"),accumulate_plugins,plugin_list)
74
 
plugin_list.sort()
75
 
 
76
 
for plugin_dir in plugin_list:
77
 
  plugin_file= os.path.join(plugin_dir,plugin_ini_fname)
78
 
  parser=ConfigParser.ConfigParser(defaults=dict(sources="",headers="", cflags="",cppflags="",cxxflags="", libs="", ldflags="", testsuite=""))
79
 
  parser.read(plugin_file)
80
 
  plugin=dict(parser.items('plugin'))
81
 
  plugin['rel_path']= plugin_dir[len(top_srcdir)+len(os.path.sep):]
82
 
  # TODO: determine path to plugin dir relative to top_srcdir... append it
83
 
  # to source files if they don't already have it
84
 
  if plugin['sources'] == "":
85
 
    plugin['sources']="%s.cc" % plugin['name']
86
 
  new_sources=""
87
 
  for src in plugin['sources'].split():
88
 
    if not src.startswith(plugin['rel_path']):
89
 
      src= os.path.join(plugin['rel_path'], src)
90
 
      new_sources= "%s %s" % (new_sources, src)
91
 
  plugin['sources']= new_sources
92
 
 
93
 
  new_headers=""
94
 
  for header in plugin['headers'].split():
95
 
    if not header.startswith(plugin['rel_path']):
96
 
      header= os.path.join(plugin['rel_path'], header)
97
 
      new_headers= "%s %s" % (new_headers, header)
98
 
  plugin['headers']= new_headers
99
 
 
100
 
  if plugin.has_key('load_by_default'):
101
 
    plugin['load_by_default']=parser.getboolean('plugin','load_by_default')
102
 
  else:
103
 
    plugin['load_by_default']=False
104
 
  # Make a yes/no version for autoconf help messages
105
 
  if plugin['load_by_default']:
106
 
    plugin['default_yesno']="yes"
107
 
  else:
108
 
    plugin['default_yesno']="no"
109
 
 
 
65
      return True
 
66
    else:
 
67
        try:
 
68
          os.unlink(self.new_fname)
 
69
        except:
 
70
          pass
 
71
 
 
72
 
 
73
def write_external_plugin():
 
74
  """Return True if the plugin had changed."""
 
75
  plugin = read_plugin_ini('.')
 
76
  expand_plugin_ini(plugin, '.')
 
77
  plugin_file = ChangeProtectedFile('pandora-plugin.ac')
 
78
  write_plugin_ac(plugin, plugin_file)
 
79
  result = plugin_file.close()
 
80
  plugin_file = ChangeProtectedFile('pandora-plugin.am')
 
81
  write_plugin_am(plugin, plugin_file)
 
82
  # Write some stub configure.ac and Makefile.am files that include the above
 
83
  result = plugin_file.close() or result
 
84
  return result
 
85
 
 
86
def write_plugin(plugin_dir):
 
87
  """Return True if the plugin had changed."""
 
88
  plugin = read_plugin_ini(plugin_dir)
 
89
  expand_plugin_ini(plugin, plugin_dir)
 
90
  write_plugin_ac(plugin, plugin_ac_file)
 
91
  write_plugin_am(plugin, plugin_am_file)
 
92
 
 
93
def write_plugin_ac(plugin, plugin_ac):
 
94
  #
 
95
  # Write plugin config instructions into plugin.ac file.
 
96
  #
110
97
  plugin_ac_file=os.path.join(plugin['rel_path'],'plugin.ac')
111
 
  plugin_am_file=os.path.join(plugin['rel_path'],'plugin.am')
112
98
  plugin_m4_dir=os.path.join(plugin['rel_path'],'m4')
113
 
 
114
99
  plugin_m4_files=[]
115
100
  if os.path.exists(plugin_m4_dir) and os.path.isdir(plugin_m4_dir):
116
101
    for m4_file in os.listdir(plugin_m4_dir):
117
102
      if os.path.splitext(m4_file)[-1] == '.m4':
118
103
        plugin_m4_files.append(os.path.join(plugin['rel_path'], m4_file))
119
 
 
120
 
  plugin['build_conditional_tag']= "BUILD_%s_PLUGIN" % plugin['name'].upper()
121
 
  plugin['name_with_dashes']= plugin['name'].replace('_','-')
122
 
  if plugin.has_key('build_conditional'):
123
 
    plugin['has_build_conditional']=True
124
 
  else:
125
 
    plugin['has_build_conditional']=False
126
 
    plugin['build_conditional']='"x${with_%(name)s_plugin}" = "xyes"' %plugin
127
 
 
128
 
  # Turn this on later plugin_lib%(name)s_plugin_la_CPPFLAGS=$(AM_CPPFLAGS) -DPANDORA_DYNAMIC_PLUGIN %(cppflags)s
129
 
 
130
 
  #
131
 
  # Write plugin build instructions into plugin.am file.
132
 
  #
133
 
  if plugin['headers'] != "":
134
 
    plugin_am.write("noinst_HEADERS += %(headers)s\n" % plugin)
135
 
  plugin_am.write("""
136
 
plugin_lib%(name)s_dir=${top_srcdir}/%(rel_path)s
137
 
EXTRA_DIST += %(rel_path)s/plugin.ini
138
 
if %(build_conditional_tag)s
139
 
  noinst_LTLIBRARIES+=plugin/lib%(name)s_plugin.la
140
 
  plugin_lib%(name)s_plugin_la_LIBADD=%(libs)s
141
 
  plugin_lib%(name)s_plugin_la_DEPENDENCIES=%(libs)s
142
 
  plugin_lib%(name)s_plugin_la_LDFLAGS=$(AM_LDFLAGS) %(ldflags)s
143
 
  plugin_lib%(name)s_plugin_la_CPPFLAGS=$(AM_CPPFLAGS) %(cppflags)s
144
 
  plugin_lib%(name)s_plugin_la_CXXFLAGS=$(AM_CXXFLAGS) %(cxxflags)s
145
 
  plugin_lib%(name)s_plugin_la_CFLAGS=$(AM_CFLAGS) %(cflags)s
146
 
 
147
 
  plugin_lib%(name)s_plugin_la_SOURCES=%(sources)s
148
 
  PANDORA_DYNAMIC_LDADDS+=${top_builddir}/plugin/lib%(name)s_plugin.la
149
 
endif
 
104
  plugin_ac.write("""
 
105
dnl Config for %(title)s
150
106
""" % plugin)
151
 
  # Add this once we're actually doing dlopen (and remove -avoid-version if
152
 
  # we move to ltdl
153
 
  #pkgplugin_LTLIBRARIES+=plugin/lib%(name)s_plugin.la
154
 
  #plugin_lib%(name)s_plugin_la_LDFLAGS=-module -avoid-version -rpath $(pkgplugindir) %(libs)s
155
 
 
156
 
 
157
 
  if os.path.exists(plugin_am_file):
158
 
    plugin_am.write('include %s\n' % plugin_am_file)
159
 
 
160
 
  #
161
 
  # Write plugin config instructions into plugin.am file.
162
 
  #
163
 
  plugin_ac.write("\n\ndnl Config for %(title)s\n" % plugin)
164
107
  for m4_file in plugin_m4_files:
165
108
    plugin_ac.write('m4_sinclude([%s])\n' % m4_file)
166
109
 
195
138
AS_IF([test "x$with_%(name)s_plugin" = "xyes"],
196
139
      [
197
140
  """ % plugin)
198
 
  if plugin['testsuite'] != "":
 
141
  if plugin['testsuite']:
199
142
    plugin_ac.write("""
200
 
        pandora_plugin_test_list="%(testsuite)s,${pandora_plugin_test_list}"
 
143
        pandora_plugin_test_list="%(name)s,${pandora_plugin_test_list}"
201
144
    """ % plugin)
202
145
 
203
 
  plugin_ac.write("""
204
 
        pandora_default_plugin_list="%(name)s,${pandora_default_plugin_list}"
 
146
  if plugin['static']:
 
147
    #pandora_default_plugin_list="%(name)s,${pandora_default_plugin_list}"
 
148
    plugin_ac.write("""
205
149
        pandora_builtin_list="builtin_%(name)s_plugin,${pandora_builtin_list}"
206
150
        pandora_plugin_libs="${pandora_plugin_libs} \${top_builddir}/plugin/lib%(name)s_plugin.la"
207
151
        PANDORA_PLUGIN_DEP_LIBS="${PANDORA_PLUGIN_DEP_LIBS} %(plugin_dep_libs)s"
208
 
      ])
209
 
""" % plugin)
210
 
 
211
 
plugin_ac.close()
212
 
plugin_am.close()
213
 
 
 
152
""" % plugin)
 
153
  else:
 
154
    plugin_ac.write("""
 
155
        pandora_default_plugin_list="%(name)s,${pandora_default_plugin_list}"
 
156
    """ % plugin)
 
157
  plugin_ac.write("      ])\n")
 
158
 
 
159
 
 
160
def expand_plugin_ini(plugin, plugin_dir):
 
161
    plugin['rel_path']= plugin_dir[len(top_srcdir)+len(os.path.sep):]
 
162
    # TODO: determine path to plugin dir relative to top_srcdir... append it to
 
163
    # source files if they don't already have it
 
164
    if plugin['sources'] == "":
 
165
      plugin['sources']="%s.cc" % plugin['name']
 
166
    new_sources=""
 
167
    for src in plugin['sources'].split():
 
168
      if not src.startswith(plugin['rel_path']):
 
169
        src= os.path.join(plugin['rel_path'], src)
 
170
        new_sources= "%s %s" % (new_sources, src)
 
171
    plugin['sources']= new_sources
 
172
    
 
173
    new_headers=""
 
174
    for header in plugin['headers'].split():
 
175
      if not header.startswith(plugin['rel_path']):
 
176
        header= os.path.join(plugin['rel_path'], header)
 
177
        new_headers= "%s %s" % (new_headers, header)
 
178
    plugin['headers']= new_headers
 
179
    
 
180
    # Make a yes/no version for autoconf help messages
 
181
    if plugin['load_by_default']:
 
182
      plugin['default_yesno']="yes"
 
183
    else:
 
184
      plugin['default_yesno']="no"
 
185
 
 
186
    
 
187
    plugin['build_conditional_tag']= "BUILD_%s_PLUGIN" % plugin['name'].upper()
 
188
    plugin['name_with_dashes']= plugin['name'].replace('_','-')
 
189
    if plugin.has_key('build_conditional'):
 
190
      plugin['has_build_conditional']=True
 
191
    else:
 
192
      plugin['has_build_conditional']=False
 
193
      plugin['build_conditional']='"x${with_%(name)s_plugin}" = "xyes"' %plugin
 
194
 
 
195
def find_testsuite(plugin_dir):
 
196
  for testdir in ['drizzle-tests','tests']:
 
197
    if os.path.isdir(os.path.join(plugin_dir,testdir)):
 
198
      return testdir
 
199
  if os.path.isdir(os.path.join('tests','suite',os.path.basename(plugin_dir))):
 
200
    return ""
 
201
  return None
 
202
 
 
203
def read_plugin_ini(plugin_dir):
 
204
    plugin_file= os.path.join(plugin_dir,plugin_ini_fname)
 
205
    parser=ConfigParser.ConfigParser(defaults=dict(sources="",headers="", cflags="",cppflags="",cxxflags="", libs="", ldflags=""))
 
206
    parser.read(plugin_file)
 
207
    plugin=dict(parser.items('plugin'))
 
208
    plugin['name']= os.path.basename(plugin_dir)
 
209
    if plugin.has_key('load_by_default'):
 
210
      plugin['load_by_default']=parser.getboolean('plugin','load_by_default')
 
211
    else:
 
212
      plugin['load_by_default']=False
 
213
    if plugin.has_key('static'):
 
214
      plugin['static']= parser.getboolean('plugin','static')
 
215
    else:
 
216
      plugin['static']= False
 
217
    if plugin.has_key('testsuite'):
 
218
      if plugin['testsuite'] == 'disable':
 
219
        plugin['testsuite']= False
 
220
    else:
 
221
      plugin_testsuite= find_testsuite(plugin_dir)
 
222
      plugin['testsuitedir']=plugin_testsuite
 
223
      if plugin_testsuite is not None:
 
224
        plugin['testsuite']=True
 
225
      else:
 
226
        plugin['testsuite']=False
 
227
 
 
228
    return plugin
 
229
 
 
230
 
 
231
def write_plugin_am(plugin, plugin_am):
 
232
  """Write an automake fragment for this plugin.
 
233
  
 
234
  :param plugin: The plugin dict.
 
235
  :param plugin_am: The file to write to.
 
236
  """
 
237
  # The .plugin.ini.stamp avoids changing the datestamp on plugin.ini which can
 
238
  # confuse VCS systems.
 
239
  plugin_am.write("""
 
240
EXTRA_DIST += %(rel_path)s/plugin.ini
 
241
 
 
242
# Prevent errors when a plugin dir is removed
 
243
%(rel_path)s/plugin.ini:
 
244
  """ % plugin)
 
245
  if plugin['headers'] != "":
 
246
    plugin_am.write("noinst_HEADERS += %(headers)s\n" % plugin)
 
247
  if plugin['testsuite']:
 
248
    if plugin.has_key('testsuitedir') and plugin['testsuitedir'] != "":
 
249
      plugin_am.write("EXTRA_DIST += %(rel_path)s/%(testsuitedir)s\n" % plugin)
 
250
  if plugin['static']:
 
251
    plugin_am.write("""
 
252
plugin_lib%(name)s_dir=${top_srcdir}/%(rel_path)s
 
253
EXTRA_DIST += %(rel_path)s/plugin.ini
 
254
if %(build_conditional_tag)s
 
255
  noinst_LTLIBRARIES+=plugin/lib%(name)s_plugin.la
 
256
  plugin_lib%(name)s_plugin_la_LIBADD=%(libs)s
 
257
  plugin_lib%(name)s_plugin_la_DEPENDENCIES=%(libs)s
 
258
  plugin_lib%(name)s_plugin_la_LDFLAGS=$(AM_LDFLAGS) %(ldflags)s
 
259
  plugin_lib%(name)s_plugin_la_CPPFLAGS=$(AM_CPPFLAGS) -DPANDORA_MODULE_NAME=%(name)s %(cppflags)s
 
260
  plugin_lib%(name)s_plugin_la_CXXFLAGS=$(AM_CXXFLAGS) %(cxxflags)s
 
261
  plugin_lib%(name)s_plugin_la_CFLAGS=$(AM_CFLAGS) %(cflags)s
 
262
 
 
263
  plugin_lib%(name)s_plugin_la_SOURCES=%(sources)s
 
264
  PANDORA_DYNAMIC_LDADDS+=${top_builddir}/plugin/lib%(name)s_plugin.la
 
265
endif
 
266
""" % plugin)
 
267
  else:
 
268
    plugin_am.write("""
 
269
plugin_lib%(name)s_dir=${top_srcdir}/%(rel_path)s
 
270
EXTRA_DIST += %(rel_path)s/plugin.ini
 
271
if %(build_conditional_tag)s
 
272
  pkgplugin_LTLIBRARIES+=plugin/lib%(name)s_plugin.la
 
273
  plugin_lib%(name)s_plugin_la_LDFLAGS=-module -avoid-version -rpath $(pkgplugindir) $(AM_LDFLAGS) %(ldflags)s
 
274
  plugin_lib%(name)s_plugin_la_LIBADD=%(libs)s
 
275
  plugin_lib%(name)s_plugin_la_DEPENDENCIES=%(libs)s
 
276
  plugin_lib%(name)s_plugin_la_CPPFLAGS=$(AM_CPPFLAGS) -DPANDORA_DYNAMIC_PLUGIN -DPANDORA_MODULE_NAME=%(name)s %(cppflags)s
 
277
  plugin_lib%(name)s_plugin_la_CXXFLAGS=$(AM_CXXFLAGS) %(cxxflags)s
 
278
  plugin_lib%(name)s_plugin_la_CFLAGS=$(AM_CFLAGS) %(cflags)s
 
279
 
 
280
  plugin_lib%(name)s_plugin_la_SOURCES=%(sources)s
 
281
endif
 
282
""" % plugin)
 
283
  plugin_am_file=os.path.join(plugin['rel_path'],'plugin.am')
 
284
  if os.path.exists(plugin_am_file):
 
285
    plugin_am.write('include %s\n' % plugin_am_file)
 
286
 
 
287
#MAIN STARTS HERE:
 
288
 
 
289
actions=[]
 
290
for arg in sys.argv:
 
291
  if arg.startswith('--top_srcdir='):
 
292
    top_srcdir=arg[12:]
 
293
  elif arg.startswith('--top_builddir='):
 
294
    top_builddir=arg[14:]
 
295
  elif arg == "--force-all":
 
296
    actions=['plugin-list','pandora-plugin.am','write']
 
297
    break
 
298
  else:
 
299
    actions.append(arg)
 
300
if len(actions) == 0:
 
301
  actions.append('write')
 
302
 
 
303
def accumulate_plugins(arg, dirname, fnames):
 
304
  # plugin_ini_fname is a name in dirname indicating dirname is a plugin.
 
305
  if plugin_ini_fname in fnames:
 
306
    arg.append(dirname)
 
307
os.path.walk(os.path.join(top_srcdir,"plugin"),accumulate_plugins,plugin_list)
 
308
 
 
309
 
 
310
if not os.path.exists("config/pandora-plugin.am") or "write" in actions:
 
311
  plugin_am_file = ChangeProtectedFile(os.path.join('config', 'pandora-plugin.am'))
 
312
  plugin_am_file.write("""
 
313
# always the current list, generated every build so keep this lean.
 
314
# plugin.list: datestamp preserved list
 
315
${srcdir}/config/plugin.list: .plugin.scan
 
316
.plugin.scan:
 
317
        @cd ${top_srcdir} && python config/register_plugins.py plugin-list
 
318
 
 
319
# Plugins affect configure; so to prevent configure running twice in a tarball
 
320
# build (once up front, once with the right list of plugins, we ship the
 
321
# generated list of plugins and the housekeeping material for that list so it
 
322
# is likewise not updated.
 
323
EXTRA_DIST += \
 
324
        config/pandora-plugin.am \
 
325
        config/pandora-plugin.ac \
 
326
        config/register_plugins.py
 
327
 
 
328
 
 
329
# Seed the list of plugin LDADDS which plugins may extend.
 
330
PANDORA_DYNAMIC_LDADDS=
 
331
 
 
332
# plugin.stamp: graph dominator for creating all per pandora-plugin.ac/am
 
333
# files. This is invoked when the code to generate such files has altered.""")
 
334
 
 
335
if not os.path.exists("config/pandora-plugin.ac") or "write" in actions:
 
336
  plugin_ac_file = ChangeProtectedFile(os.path.join('config', 'pandora-plugin.ac'))
 
337
  plugin_ac_file.write("dnl Generated file, run make to rebuild\n")
 
338
 
 
339
 
 
340
if os.path.exists('plugin.ini'):
 
341
  # Are we in a plugin dir which wants to have a self-sufficient build system?
 
342
  plugin_list=['.']
 
343
  write_external_plugin()
 
344
else:
 
345
  plugin_list_file = ChangeProtectedFile(os.path.join('config', 'pandora-plugin.list'))
 
346
  for p in plugin_list:
 
347
    plugin_list_file.write(p)
 
348
    plugin_list_file.write("\n")
 
349
  plugin_list.sort()
 
350
  plugin_list_file.close()
 
351
 
 
352
if not os.path.exists("config/pandora-plugin.am") or 'write' in actions:
 
353
  plugin_am_file.write("\nconfig/pandora-plugin.am: ${top_srcdir}/config/plugin.list ${top_srcdir}/config/register_plugins.py ")
 
354
  for plugin_dir in plugin_list:
 
355
    plugin_am_file.write("\\\n\t%s/plugin.ini " % plugin_dir)
 
356
  plugin_am_file.write("\n\tcd ${top_srcdir} && python config/register_plugins.py write\n")
 
357
  for plugin_dir in plugin_list:
 
358
    write_plugin(plugin_dir)
 
359
 
 
360
if plugin_am_file is not None:
 
361
  plugin_am_file.close()
 
362
if plugin_ac_file is not None:
 
363
  plugin_ac_file.close()