configure.py

#!/usr/bin/python
#
#     Copyright (C) 2016  Adam Jirasek
# 
#     This program is free software: you can redistribute it and/or modify
#     it under the terms of the GNU Lesser General Public License as published by
#     the Free Software Foundation, either version 3 of the License, or
#     (at your option) any later version.
# 
#     This program is distributed in the hope that it will be useful,
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#     GNU Lesser General Public License for more details.
# 
#     You should have received a copy of the GNU Lesser General Public License
#     along with this program.  If not, see <http://www.gnu.org/licenses/>.
#     
#     contact: libm3l@gmail.com
# 
#
#
# Description: python configuration script. It loops over all subdirectories in source directories
# in the project and links:
# src_dir_path.mk   - specifies source directory withe source files
# Makefike
# project.dep       - project depenency file with source code dependencies
# .py               - all .py scritps which may be present
#
# avoid links for these directories:
# pyhon_dep         - contains python script for making dependencies, it is used in source directory
# config            - contains files with settings specific to compiler
# .git              - any .git repository specific files
# .svn              - any .svn repository specific files
#
# 
# History:
# Version   Date       Patch number  CLA     Comment
# -------   --------   --------      ---     -------
# 1.1       10/10/16                         Initial implementation
#
#
#
import os
import re
import glob
import fnmatch
import os
import sys
import errno
import copy
import platform

#Definitions

def run(comp,files=None,verbose=True,overwrite=None,output=None,macros={},build='',lib=''):
#
#  definition of parameters
#
    print_header()
    linkfiles =(['src_dir_path.mk', 'Makefile', 'depend.mk'])
    exclude =(['python_dep', 'config', '.git', '.svn'])     
#
#   get path of the source files, found from location of this script which is located in the root
#   directory of the source code
#
    path = os.path.dirname(os.path.abspath(__file__))
#
#   get current directory
#
    cwd = os.getcwd()
#
#   if path for source does not exit, terminate
#
    path = check_path(path=path)
    if not os.path.isdir(path):
      print("  ")
      print("\033[031mERROR:\033[039m specified project source location \033[032m"+path+"\033[039m does not exist, terminating .... ") 
      sys.exit()

    cwd = check_path(path=cwd)

    print("  ")
    print("\033[031mDIAG:\033[039m project location is                  \033[032m"+path+"\033[039m")  	
    print("\033[031mDIAG:\033[039m Intended location of compillation is \033[032m"+cwd+"\033[039m")    
#
#   if pathe to source and path to location of compilation directory are the same
#   terminate, do not allow compilation in the source code directory
#
    if cwd == path:
        print(".....")
        print ("\033[031mError:\033[039m project location is the same as inteded location of compillation \033[032m"+path+"\033[039m")  	
        print ("\033[031m      \033[039m choose different location \033[032m"  "\033[039m")
        print("       terminating .... ") 	
        sys.exit()
#
#  creating config file
#
    print("  ")
    print("\033[031mDIAG:\033[039m creating configure file \033[032m \033[039m")  	
    print("  ")
#
#  specify build directory where all executables will be located
#
    if build == '':
      print("  ")
      print("\033[031mDIAG:\033[039m Bild directory not specified, setting it to \033[032m "+cwd+platform.machine()+"/bin\033[039m")  	
      print("  ")
      bin_dir=cwd+platform.machine()+'/bin'
      lib_dir=cwd+platform.machine()+'/lib64'
    else:
      bin_dir=build
      lib_dir=lib
#
#  specify lib directory where all executables will be located
#
    if build == '':
      print("  ")
      print("\033[031mDIAG:\033[039m Library directory not specified, setting it to \033[032m "+cwd+platform.machine()+"/lib64\033[039m")  	
      print("  ")
      lib_dir=cwd+platform.machine()+'/lib64'
    else:
      lib_dir=lib
#
#  create configuration file config.mk
#
    ok = mkconfigfile(path=path, cwd=cwd,version=comp, bin_dir=bin_dir, lib_dir=lib_dir)
#
#   create structure and link necessary files
#   ie. create the same tree structure as source files and link "linkfiles" specified above 
#
    print("  ")
    print("\033[031mDIAG:\033[039m Recreating project tree structure and linking files \033[032m \033[039m .....")  	
    print("\033[031mDIAG:\033[039m Project root directory .... \033[032m \033[039m .....")  	
    ok=prepare_compiler(root_path=path, cwd=cwd, linkfiles=linkfiles)
    print("  ")
    print("\033[031mDIAG:\033[039m Subdirectories .... \033[032m \033[039m")  	
    ok=mkdir_structure(root_path=path, cwd=cwd, exclude=exclude, linkfiles=linkfiles)

    print("  ")
    print("\033[031mNOTE:\033[039m Bild directory is set to \033[032m "+bin_dir+"\033[039m")  	
    print("\033[031m------------------------------------------------------------------------\033[039m")  	
    print("  ")

    print("  ")
    print("\033[031mSUCCESS:\033[039m Setup was succesful \033[032m \033[039m")  	
    print("  ")

#   list directories and subdirectories

def get_all_dirs(path,exclude):

    matches = []
    matchesf = []

    for root, dirnames, filenames in os.walk(path):
        for filename in fnmatch.filter(dirnames, '*'):
            matches.append(os.path.join(root, filename))

    length = len(path)
    for name in matches:
        dirtmp = name.replace(name[:length], '')
        matchesf.append(dirtmp)

    for d in list(matchesf):
        for word in exclude:
           if word in d:
              matchesf.remove(d) 
 
    print ("\033[031mDIAG:\033[039m Following list of subdirectories will be processed ... \033[032m \033[039m")      
    for name in matchesf:
        print ("\033[032m      "+name+"\033[039m")  

    return matchesf

def prepare_compiler(root_path,cwd, linkfiles):
#
#  list all dirs in project except directories specified in exclude
#
   linknew = copy.copy(linkfiles)
   linknew.append('rules.mk')
   linknew.remove('depend.mk')

   for word in linknew:
      try:
        os.remove(word)
        print ("\033[031mDIAG: \033[039m file \033[032m"+word+"\033[039m already exists, removing ....")
      except OSError:
        pass

      source = root_path+'/'+word
      dest   = cwd+'/'+word
      print ("\033[031mDIAG: \033[039m linking file \033[032m"+source+"\033[039m ....")
      linkfile = os.symlink( source, dest)

   return 

def mkdir_structure(root_path,cwd, exclude, linkfiles):
#
#  list all dirs in project except directories specified in exclude
#
    dirs=get_all_dirs(path=root_path,exclude=exclude) 

    print(" ")
#
#  loop over diorectories and make them 
#
    for dir in dirs:
       try:
          os.makedirs(dir)
       except OSError as e:
         if e.errno != errno.EEXIST:
            raise  # raises the error again
         else:
          print ("\033[031mDIAG: \033[039m directory \033[032m"+dir+"\033[039m already exists, keeping it ....")
#
#  loop over new directories and link the linkfiles
#  from project directories
#
    print("  ")
    length = len(cwd)

    for subdir, dirs, files in os.walk(cwd):
       for dir in dirs:
          subdir = check_path(path=subdir)
#
#  dirtmp is a source directory
#  newdir is a target directory
#
          newdir = subdir+dir
          print ("\033[031mDIAG: \033[039m processing directory \033[032m"+newdir+"\033[039m ....")
          dirtmp = subdir.replace(subdir[:length], '')
          dirtmp = check_path(path=dirtmp)          
          dirtmp = root_path + dirtmp+dir

          os.chdir(newdir)
#
#  link over list of files specified in linkfiels and link them 
#
          for word in linkfiles:
             try:
               os.remove(word)
               print ("\033[031mDIAG: \033[039m file \033[032m"+word+"\033[039m already exists, removing ....")
             except OSError:
                pass

             source = dirtmp+'/'+word
             dest   = newdir+'/'+word
             if os.path.exists(source):
               print ("\033[031mDIAG: \033[039m linking file \033[032m"+source+"\033[039m ....")
               linkfile = os.symlink( source, dest)
#
# check if python script, link it too
#
          if os.path.isdir(dirtmp):
            for file in os.listdir(dirtmp):
              if file.endswith(".py"):
                source = dirtmp+'/'+file
                dest   = newdir+'/'+file
                try:
                  os.remove(file)
                  print ("\033[031mDIAG: \033[039m script file \033[032m"+file+"\033[039m already exists, removing ....")
                except OSError:
                  pass

                print ("\033[031mDIAG: \033[039m linking sript file \033[032m"+source+"\033[039m ....")
                linkfile = os.symlink( source, dest)

          os.chdir(cwd)
          print("  ")


    return 


def check_path(path):
    if not(path.endswith("/")):
        path=path + "/"

    return path

def mkconfigfile(path, cwd,version, bin_dir, lib_dir):
    filename = path+'/config/compset.'+version

    if not(os.path.exists(filename)):
        print ("\033[031mError: \033[039m \033[031m"+version+"\033[039m verion of compiler is not available")
        print ("\033[031m       \033[039m available options are: \033[032m gfortran\033[039m")
        print ("\033[031m       \033[039m                        \033[032m gfortran_debug\033[039m")
        print ("\033[031m       \033[039m                        \033[032m x86_64\033[039m")
        print ("\033[031m       \033[039m                        \033[032m x86_64_debug\033[039m") 
        sys.exit()
        

    exec_dir=bin_dir
    
    confname =  'config.mk'
    
    try:
        os.remove(confname)
        print ("\033[031mDIAG: \033[039m config.mk file \033[032m \033[039m already exists, removing ....")
    except OSError:
        pass
    
    fconfig = open(confname, 'w')
    
    fconfig.write("#\n")
    fconfig.write("SHELL              = /bin/bash\n")
    fconfig.write("#\n")

    fconfig.write("#\n")
    fconfig.write("# Compiler settings\n")
    fconfig.write("#\n")

    with open(filename) as f:
        for line in f:
           if ( not(line.startswith('#')) or not line.strip()): 
                print(line)
                fconfig.write(line)

    fconfig.write("#\n")  
    fconfig.write("#  bin_dir is the base directory with installed executables\n")
    fconfig.write("#\n")
    fconfig.write('bin_dir='+exec_dir+"\n")
    fconfig.write("#\n")
    fconfig.write("#  lib_dir is the fll library directory\n")
    fconfig.write("#\n")
    fconfig.write('lib_dir='+lib_dir+"\n")
    fconfig.write("#\n")
    fconfig.write("#\n")
    fconfig.write("#  MACHINE identifies the host machine type")
    fconfig.write("#\n")
    fconfig.write("MACHINE="+platform.machine()+"\n")
    fconfig.write("#\n")
    fconfig.write("#  Install command (or cp -p if install is not found)\n")
    fconfig.write("#\n")
    fconfig.write("INSTALL = install -c\n")
    fconfig.write("#\n")
    fconfig.write("PROJ_ROOT_PATH="+path+"\n")
    fconfig.write("MAKEDEPEND="+path+"/python_def/fort_depend.py\n")
                
    f.close()
    fconfig.close()
#
#  make exec directory
#
    if not os.path.isdir(exec_dir):
      print("  ")
      print("\033[031mERROR:\033[039m Creating exec directory \033[032m"+exec_dir+"\033[039m .... ")
      os.makedirs(exec_dir) 

#
#  make library directory
#
    if not os.path.isdir(lib_dir):
      print("  ")
      print("\033[031mERROR:\033[039m Creating library directory \033[032m"+lib_dir+"\033[039m .... ")
      os.makedirs(lib_dir)

    cwd = check_path(path=cwd)

class file_obj:
    def __init__(self):
        self.file_name=None
        self.uses=None
        self.contains=None
        self.depends_on=None

def print_header():
     print("  ")
     print ("\033[031m**************************************************************** \033[039m")
     print ("\033[031m*                                                              * \033[039m")
     print ("\033[031m*\033[039m         this is a configure file for FLL library \033[031m            * \033[039m")
     print ("\033[031m*                                                              * \033[039m")
     print ("\033[031m**************************************************************** \033[039m")
#Script
if __name__ == "__main__":
    import argparse

    # Add command line arguments
    parser = argparse.ArgumentParser(description='FLL configure script')
    parser.add_argument('-f','--files',nargs='+',help='Files to process')
    parser.add_argument('-D',nargs='+',action='append',metavar='NAME=DESCRIPTION',
                        help="""The macro NAME is replaced by DEFINITION in 'use' statements""")
    parser.add_argument('-b','--build',nargs=1,help='Build directory', default='')
    parser.add_argument('-L','--libdir',nargs=1,help='FLL library directory', default='')
    parser.add_argument('-o','--output',nargs=1,help='Output file')
    parser.add_argument('-v','--verbose',action='store_true',help='explain what is done')
    parser.add_argument('-w','--overwrite',action='store_true',help='Overwrite output file without warning')
    parser.add_argument('-c','--compiler',nargs=1,help='Compiler configuration')

    # Parse the command line arguments
    args = parser.parse_args()

    # Assemble a dictionary out of the macro definitions
    macros = {}
    if args.D:
        for arg in args.D:
            for var in arg:
                temp = var.split('=')
            macros[temp[0]] = temp[1]

    output = args.output[0] if args.output else None
    build = args.build[0] if args.build else ''
    libdir = args.libdir[0] if args.libdir else ''

    compiler = args.compiler[0] if args.compiler else None
    
    if not compiler:
        print ("\033[031mError: \033[039m missing compiler settings, specify option \033[031m-c \033[032m")
        print ("\033[031m       \033[039m available options are: \033[032m gfortran\033[039m")
        print ("\033[031m       \033[039m                        \033[032m gfortran_debug\033[039m")
        print ("\033[031m       \033[039m                        \033[032m x86_64\033[039m")
        print ("\033[031m       \033[039m                        \033[032m x86_64_debug\033[039m") 
        sys.exit()

    run(comp=compiler,verbose=args.verbose, overwrite=args.overwrite, macros=macros, output=output, build=build, lib=libdir)