blob: f349f9e30104f05dd2850b2948188f4bc744b44f [file] [log] [blame]
Andreas Wundsam27303462013-07-16 12:52:35 -07001# Copyright 2013, Big Switch Networks, Inc.
2#
3# LoxiGen is licensed under the Eclipse Public License, version 1.0 (EPL), with
4# the following special exception:
5#
6# LOXI Exception
7#
8# As a special exception to the terms of the EPL, you may distribute libraries
9# generated by LoxiGen (LoxiGen Libraries) under the terms of your choice, provided
10# that copyright and licensing notices generated by LoxiGen are not altered or removed
11# from the LoxiGen Libraries and the notice provided below is (i) included in
12# the LoxiGen Libraries, if distributed in source code form and (ii) included in any
13# documentation for the LoxiGen Libraries, if distributed in binary form.
14#
15# Notice: "Copyright 2013, Big Switch Networks, Inc. This library was generated by the LoxiGen Compiler."
16#
17# You may not use this file except in compliance with the EPL or LOXI Exception. You may obtain
18# a copy of the EPL at:
19#
20# http://www.eclipse.org/legal/epl-v10.html
21#
22# Unless required by applicable law or agreed to in writing, software
23# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
25# EPL for the specific language governing permissions and limitations
26# under the EPL.
27
28"""
29@brief Main Java Generation module
30"""
31
32import pdb
33import os
34import shutil
35
36import of_g
37from loxi_ir import *
38import lang_java
Andreas Wundsame916d6f2013-07-30 11:33:58 -070039import test_data
Andreas Wundsam70aa5492013-10-23 15:26:53 -070040from collections import namedtuple
Yotam Harchol466b3212013-08-15 12:14:46 -070041from import_cleaner import ImportCleaner
Andreas Wundsam27303462013-07-16 12:52:35 -070042
43import loxi_utils.loxi_utils as loxi_utils
44
45import java_gen.java_model as java_model
46
Rich Lane0bc84ff2013-11-10 17:33:17 -080047def gen_all_java():
Andreas Wundsamd83883e2013-07-25 14:50:51 -070048 basedir= '%s/openflowj' % of_g.options.install_dir
Andreas Wundsam27303462013-07-16 12:52:35 -070049 print "Outputting to %s" % basedir
50 if os.path.exists(basedir):
51 shutil.rmtree(basedir)
52 os.makedirs(basedir)
53 copy_prewrite_tree(basedir)
Andreas Wundsam70aa5492013-10-23 15:26:53 -070054 gen = JavaGenerator(basedir, JavaGeneratorOptions(instrument=True))
Andreas Wundsam27303462013-07-16 12:52:35 -070055 gen.create_of_interfaces()
56 gen.create_of_classes()
57 gen.create_of_const_enums()
Andreas Wundsam5204de22013-07-30 11:34:45 -070058 gen.create_of_factories()
Andreas Wundsam27303462013-07-16 12:52:35 -070059
Andreas Wundsam70aa5492013-10-23 15:26:53 -070060JavaGeneratorOptions = namedtuple("JavaGeneratorOptions", ("instrument",))
Andreas Wundsam27303462013-07-16 12:52:35 -070061
62class JavaGenerator(object):
63 templates_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'templates')
64
Andreas Wundsam70aa5492013-10-23 15:26:53 -070065 def __init__(self, basedir, gen_opts):
Andreas Wundsam27303462013-07-16 12:52:35 -070066 self.basedir = basedir
67 self.java_model = java_model.model
Andreas Wundsam70aa5492013-10-23 15:26:53 -070068 self.gen_opts = gen_opts
Andreas Wundsam27303462013-07-16 12:52:35 -070069
Andreas Wundsame916d6f2013-07-30 11:33:58 -070070 def render_class(self, clazz, template, src_dir=None, **context):
71 if not src_dir:
72 src_dir = "src/main/java/"
73
Andreas Wundsam27303462013-07-16 12:52:35 -070074 context['class_name'] = clazz.name
75 context['package'] = clazz.package
Andreas Wundsamd10e1c52013-08-01 22:02:49 -070076 context['template_dir'] = self.templates_dir
Andreas Wundsam70aa5492013-10-23 15:26:53 -070077 context['genopts']= self.gen_opts
Andreas Wundsam27303462013-07-16 12:52:35 -070078
Andreas Wundsame916d6f2013-07-30 11:33:58 -070079 filename = os.path.join(self.basedir, src_dir, "%s/%s.java" % (clazz.package.replace(".", "/"), clazz.name))
Andreas Wundsam27303462013-07-16 12:52:35 -070080 dirname = os.path.dirname(filename)
81 if not os.path.exists(dirname):
82 os.makedirs(dirname)
83 prefix = '//::(?=[ \t]|$)'
84 print "filename: %s" % filename
85 with open(filename, "w") as f:
86 loxi_utils.render_template(f, template, [self.templates_dir], context, prefix=prefix)
Andreas Wundsam70aa5492013-10-23 15:26:53 -070087
Yotam Harchol466b3212013-08-15 12:14:46 -070088 try:
89 cleaner = ImportCleaner(filename)
90 cleaner.find_used_imports()
91 cleaner.rewrite_file(filename)
92 except:
93 print 'Cannot clean imports from file %s' % filename
Andreas Wundsam27303462013-07-16 12:52:35 -070094
95 def create_of_const_enums(self):
96 for enum in self.java_model.enums:
97 if enum.name in ["OFPort"]:
98 continue
99 self.render_class(clazz=enum,
100 template='const.java', enum=enum, all_versions=self.java_model.versions)
101
Andreas Wundsambf1dbbd2013-07-30 11:07:59 -0700102 for version in enum.versions:
Yotam Harchol791e4882013-09-05 16:32:56 -0700103 clazz = java_model.OFGenericClass(package="org.projectfloodlight.openflow.protocol.ver{}".format(version.of_version), name="{}SerializerVer{}".format(enum.name, version.of_version))
Andreas Wundsam7cfeac32013-09-17 13:53:48 -0700104
105 if enum.is_bitmask:
106 self.render_class(clazz=clazz, template="const_set_serializer.java", enum=enum, version=version)
107 else:
108 self.render_class(clazz=clazz, template="const_serializer.java", enum=enum, version=version)
Andreas Wundsambf1dbbd2013-07-30 11:07:59 -0700109
Andreas Wundsam27303462013-07-16 12:52:35 -0700110 def create_of_interfaces(self):
111 """ Create the base interfaces for of classes"""
112 for interface in self.java_model.interfaces:
113 #if not utils.class_is_message(interface.c_name):
114 # continue
115 self.render_class(clazz=interface,
116 template="of_interface.java", msg=interface)
117
118 def create_of_classes(self):
119 """ Create the OF classes with implementations for each of the interfaces and versions """
120 for interface in self.java_model.interfaces:
Andreas Wundsam27303462013-07-16 12:52:35 -0700121 for java_class in interface.versioned_classes:
Andreas Wundsam001b1822013-08-02 22:25:55 -0700122 if self.java_model.generate_class(java_class):
123 if not java_class.is_virtual:
124 self.render_class(clazz=java_class,
125 template='of_class.java', version=java_class.version, msg=java_class,
126 impl_class=java_class.name)
Andreas Wundsam27303462013-07-16 12:52:35 -0700127
Andreas Wundsam001b1822013-08-02 22:25:55 -0700128 self.create_unit_test(java_class.unit_test)
129 else:
130 disc = java_class.discriminator
131 if disc:
132 self.render_class(clazz=java_class,
133 template='of_virtual_class.java', version=java_class.version, msg=java_class,
134 impl_class=java_class.name, model=self.java_model)
135 else:
136 print "Class %s virtual but no discriminator" % java_class.name
137 else:
138 print "Class %s ignored by generate_class" % java_class.name
Andreas Wundsame916d6f2013-07-30 11:33:58 -0700139
Yotam Harchol466b3212013-08-15 12:14:46 -0700140 def create_unit_test(self, unit_tests):
141 if unit_tests.has_test_data:
142 for i in range(unit_tests.length):
143 unit_test = unit_tests.get_test_unit(i)
144 if unit_test.has_test_data:
145 self.render_class(clazz=unit_test,
146 template='unit_test.java', src_dir="src/test/java",
147 version=unit_test.java_class.version,
148 test=unit_test, msg=unit_test.java_class,
149 test_data=unit_test.test_data)
Andreas Wundsame916d6f2013-07-30 11:33:58 -0700150
151 def create_of_factories(self):
Andreas Wundsame0d52be2013-08-22 07:52:13 -0700152 for factory in self.java_model.of_factories:
153 self.render_class(clazz=factory, template="of_factory_interface.java", factory=factory)
154 for factory_class in factory.factory_classes:
155 self.render_class(clazz=factory_class, template="of_factory_class.java", factory=factory_class, model=self.java_model)
Yotam Harchol791e4882013-09-05 16:32:56 -0700156 self.render_class(clazz=java_model.OFGenericClass(package="org.projectfloodlight.openflow.protocol", name="OFFactories"), template="of_factories.java", versions=self.java_model.versions)
Andreas Wundsame916d6f2013-07-30 11:33:58 -0700157
Andreas Wundsam27303462013-07-16 12:52:35 -0700158def copy_prewrite_tree(basedir):
159 """ Recursively copy the directory structure from ./java_gen/pre-write
160 into $basedir"""
161 print "Copying pre-written files into %s" % basedir