skel_wrapper.py

Go to the documentation of this file.

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
#  @file skel_wrapper.py
#  @brief CORBA skelton/stub wrapper generator module
#  @date $Date: 2008-03-06 06:51:10 $
#  @author Noriaki Ando <n-ando@aist.go.jp>
# 
#  Copyright (C) 2004-2011
#      Intelligent Systems Research Institute,
#      National Institute of
#          Advanced Industrial Science and Technology (AIST), Japan
#      All rights reserved.
# 
#  $Id: skel_wrapper.py 2521 2014-03-03 07:47:45Z n-ando $
# 

import yat
import re
import sys
import os
import time


#------------------------------------------------------------
# Server Skelton header template
#------------------------------------------------------------
skel_h = """// -*- C++ -*-
/*!
 *
 * THIS FILE IS GENERATED AUTOMATICALLY!! DO NOT EDIT!!
 *
 * @file [skel_h]
 
 * @brief [basename] server skeleton header wrapper code
 * @date [date]
 
 *
 */

#ifndef [skel_h_inc_guard]

#define [skel_h_inc_guard]



[config_inc]

#if   defined ORB_IS_TAO
#  include "[include_dir][basename]C.h"
#  include "[include_dir][basename]S.h"
#elif defined ORB_IS_OMNIORB
#  if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__)
#    undef USE_stub_in_nt_dll
#  endif
#  include "[include_dir][basename].hh"
#elif defined ORB_IS_MICO
#  include "[include_dir][basename].h"
#elif defined ORB_IS_ORBIT2
#  include "[include_dir]/[basename]-cpp-stubs.h"
#  include "[include_dir]/[basename]-cpp-skels.h"
#elif defined ORB_IS_RTORB
#  include "[include_dir][basename].h"
#else
#  error "NO ORB defined"
#endif

#endif // [skel_h_inc_guard]

"""


#------------------------------------------------------------
# Server Skelton source template
#------------------------------------------------------------
skel_cpp = """// -*- C++ -*-
/*!
 *
 * THIS FILE IS GENERATED AUTOMATICALLY!! DO NOT EDIT!!
 *
 * @file [skel_cpp]
 
 * @brief [basename] server skeleton wrapper
 * @date [date]
 
 *
 */

#include "[skel_h]"

#if defined ORB_IS_TAO
#  include "[include_dir][basename]C.cpp"
#  include "[include_dir][basename]S.cpp"
#elif defined ORB_IS_OMNIORB
#  include "[include_dir][basename]SK.cc"
#  include "[include_dir][basename]DynSK.cc"
#elif defined ORB_IS_MICO
#  include "[include_dir][basename].cc"
#  include "[include_dir][basename]_skel.cc"
#elif defined ORB_IS_ORBIT2
#  include "[include_dir][basename]-cpp-stubs.cc"
#  include "[include_dir][basename]-cpp-skels.cc"
#elif defined ORB_IS_RTORB
[include_openrtm_idl_decls]
#  include "[include_dir][basename]-common.c"
#  include "[include_dir][basename]-stubs.c"
#  include "[include_dir][basename]-skels.c"
#  include "[include_dir][basename]-skelimpl.c"
#else
#  error "NO ORB defined"
#endif

// end of [skel_cpp]

"""

#------------------------------------------------------------
# Client Stub header template
#------------------------------------------------------------
stub_h = """// -*- C++ -*-
/*!
 *
 * THIS FILE IS GENERATED AUTOMATICALLY!! DO NOT EDIT!!
 *
 * @file [stub_h]
 
 * @brief [basename] client stub header wrapper code
 * @date [date]
 
 *
 */

#ifndef [stub_h_inc_guard]

#define [stub_h_inc_guard]



[config_inc]

#if   defined ORB_IS_TAO
#  include "[include_dir][basename]C.h"
#elif defined ORB_IS_OMNIORB
#  if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__)
#    undef USE_stub_in_nt_dll
#  endif
#  include "[include_dir][basename].hh"
#elif defined ORB_IS_MICO
#  include "[include_dir][basename].h"
#elif defined ORB_IS_ORBIT2
#  include "[include_dir][basename]-cpp-stubs.h"
#elif defined ORB_IS_RTORB
#  include "[include_dir][basename].h"
#else
#  error "NO ORB defined"
#endif

#endif // [stub_h_inc_guard]

"""
 
#------------------------------------------------------------
# Client Stub soruce template
#------------------------------------------------------------
stub_cpp = """// -*- C++ -*-
/*!
 *
 * THIS FILE IS GENERATED AUTOMATICALLY!! DO NOT EDIT!!
 *
 * @file [stub_cpp]
 
 * @brief [basename] client stub wrapper code
 * @date [date]
 
 *
 */

#include "[stub_h]"

#if   defined ORB_IS_TAO
#  include "[include_dir][basename]C.cpp"
#elif defined ORB_IS_OMNIORB
#  include "[include_dir][basename]SK.cc"
#  include "[include_dir][basename]DynSK.cc"
#elif defined ORB_IS_MICO
#  include "[include_dir][basename].cc"
#elif defined ORB_IS_ORBIT2
#  include "[include_dir][basename]-cpp-stubs.cc"
#elif defined ORB_IS_RTORB
[include_openrtm_idl_decls]
#  include "[include_dir][basename]-common.c"
#  include "[include_dir][basename]-stubs.c"
#else
#  error "NO ORB defined"
#endif

// end of [stub_cpp]

"""


config_inc = """
#include <[rtm_dir]config_rtc.h>
#undef PACKAGE_BUGREPORT
#undef PACKAGE_NAME
#undef PACKAGE_STRING
#undef PACKAGE_TARNAME
#undef PACKAGE_VERSION
"""

class skel_wrapper:
        def __init__(self, idl_fname, skel_suffix = "Skel",
                     stub_suffix = "Stub", include_dir = "",
                     config_inc = "", output_dir = "./"):
                self.data = {}
                self.data["include_dir"] = include_dir
                self.data["output_dir"] = output_dir
                self.data["idl_fname"] = idl_fname
                m = re.search("\.[iI][dD][lL]$", idl_fname)
                if m:
                        basename = idl_fname.replace(m.group(0), "")
                else:
                        sys.stderr.write("Invalid IDL file name specified.\n")
                        sys.exit(1)
                        
                dirname  = os.path.dirname(basename) + "/"
                basename = os.path.basename(basename)
                self.data["basename"] = basename
                self.data["skel_h"]   = basename + skel_suffix + ".h"
                self.data["skel_cpp"] = basename + skel_suffix + ".cpp"
                self.data["stub_h"]   = basename + stub_suffix + ".h"
                self.data["stub_cpp"] = basename + stub_suffix + ".cpp"

                skel_h_guard = dirname + self.data["skel_h"].replace(".","_")
                skel_h_guard = skel_h_guard.replace("/","_")
                skel_h_guard = skel_h_guard.upper()
                stub_h_guard = dirname + self.data["stub_h"].replace(".","_")
                stub_h_guard = stub_h_guard.replace("/","_")
                stub_h_guard = stub_h_guard.upper()
                self.data["skel_h_inc_guard"] = skel_h_guard
                self.data["stub_h_inc_guard"] = stub_h_guard
                
                self.data["date"] = time.ctime()
                self.data["config_inc"] = config_inc
                if basename == "OpenRTM-aist" :
                        self.data["include_openrtm_idl_decls"] = ""
                else:
                        self.data["include_openrtm_idl_decls"] = "#  include \"OpenRTM-aist-decls.h\"\n"
                return

        def gen(self, fname, temp_txt):
                data = self.data
                t = yat.Template(temp_txt)
                text = t.generate(data)

                if os.access(fname, os.F_OK): # file exists
                        f = file(fname, "r")
                        oldtext = f.read()
                        f.close()

                        newtext = re.sub(" \@date.*?\n", "", text)
                        oldtext2 = re.sub(" \@date.*?\n", "", oldtext)
                        if newtext == oldtext2:
                                print "\"" + fname + \
                            "\" exists and contents is same."
                                print "No need to generate the file."
                                return
                        else:
                                print "\"", fname, \
                            "\" already exists but contents are not same"

                f = file(fname, "w")
                f.write(text)
                f.close()
                print "\"" + fname + "\"" " was generated."
                return

        def print_skel_h(self):
                fname = self.data["output_dir"] + self.data["skel_h"]
                self.gen(fname, skel_h)
                return

        def print_skel_cpp(self):
                fname = self.data["output_dir"] + self.data["skel_cpp"]
                self.gen(fname, skel_cpp)
                return

        def print_stub_h(self):
                fname = self.data["output_dir"] + self.data["stub_h"]
                self.gen(fname, stub_h)
                return

        def print_stub_cpp(self):
                fname = self.data["output_dir"] + self.data["stub_cpp"]
                self.gen(fname, stub_cpp)
                return

        def print_all(self):
                self.print_skel_h()
                self.print_skel_cpp()
                self.print_stub_h()
                self.print_stub_cpp()
                return

        def generate(self):
                self.print_all()


if __name__ == "__main__":
        w = skel_wrapper("Hoge.idl", "_Skel", "_Stub", "rtm/idl/", "")
        w.generate()