blob: 4d64e8d1ba3740931e6fb16f1ac4d221fa2622de [file] [log] [blame]
Rich Lanea06d0c32013-03-25 08:52:03 -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"""
29Python backend for LOXI
30
31This language specific file defines a dictionary 'targets' that
32defines the generated files and the functions used to generate them.
33
34For each generated file there is a generate_* function in py_gen.codegen
35and a Tenjin template under py_gen/templates.
36
37Target directory structure:
38 pyloxi:
39 loxi:
40 __init__.py
41 of10:
42 __init__.py
43 action.py # Action classes
44 common.py # Structs shared by multiple messages
45 const.py # OpenFlow constants
46 message.py # Message classes
47 util.py # Utility functions
48 of12: ...
49 of13: ...
50
51The user will add the pyloxi directory to PYTHONPATH. Then they can
52"import loxi" or "import loxi.of10". The idiomatic import is
53"import loxi.of10 as ofp". The protocol modules (e.g. of10) import
54all of their submodules, so the user can access "ofp.message" without
55further imports. The protocol modules also import the constants from
56the const module directly into their namespace so the user can access
57"ofp.OFPP_NONE".
58"""
59
60import py_gen
61import py_gen.util
62import py_gen.codegen
63
64versions = {
65 1: "of10",
Jonathan Stout3edbac92013-04-05 11:30:49 -040066 2: "of11",
67 3: "of12",
68 4: "of13"
Rich Lanea06d0c32013-03-25 08:52:03 -070069}
70
71prefix = 'pyloxi/loxi'
72
73modules = ["action", "common", "const", "message", "util"]
74
75def make_gen(name, version):
76 fn = getattr(py_gen.codegen, "generate_" + name)
77 return lambda out, name: fn(out, name, version)
78
79def static(template_name):
80 return lambda out, name: py_gen.util.render_template(out, template_name)
81
82targets = {
83 prefix+'/__init__.py': static('toplevel_init.py'),
84 prefix+'/pp.py': static('pp.py'),
85}
86
87for version, subdir in versions.items():
88 targets['%s/%s/__init__.py' % (prefix, subdir)] = make_gen('init', version)
89 for module in modules:
90 filename = '%s/%s/%s.py' % (prefix, subdir, module)
91 targets[filename] = make_gen(module, version)