Source code for ElementsKernel.RemoveCppClass

#
# Copyright (C) 2012-2020 Euclid Science Ground Segment
#
# This library 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.0 of the License, or (at your option)
# any later version.
#
# This library 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 library; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#

""" This script will remove all files related to a C++ class

:file: ElementsKernel/RemoveCppClass.py
:author: Nicolas Morisset

:date: 02/10/16

"""

import argparse
import os
from ElementsKernel import ProjectCommonRoutines
from ElementsKernel import ParseCmakeLists
from ElementsKernel import Logging
from ElementsKernel import Exit

try:
    from builtins import input
except ImportError:
    from __builtin__ import input

CMAKE_LISTS_FILE = 'CMakeLists.txt'

LOGGER = Logging.getLogger(__name__)

################################################################################


def getAllFiles(class_name, module_directory, module_name):
    """
    Get all files related to a class
    """
    delete_file_list = []
    file_name_h = os.path.join(module_directory, module_name, class_name) + '.h'
    if os.path.exists(file_name_h):
        delete_file_list.append(file_name_h)
    file_name_cpp = os.path.join(module_directory, 'src', 'lib', class_name) + '.cpp'
    if os.path.exists(file_name_cpp):
        delete_file_list.append(file_name_cpp)
    file_name_test = os.path.join(module_directory, 'tests', 'src', class_name) + '_test.cpp'
    if os.path.exists(file_name_test):
        delete_file_list.append(file_name_test)

    return delete_file_list

################################################################################


def updateCmakeListsFile(module_dir, class_name):
    """
    Update the <CMakeLists.txt> file
    """
    LOGGER.info('Updating the <%s> file', CMAKE_LISTS_FILE)
    cmake_filename = os.path.join(module_dir, CMAKE_LISTS_FILE)

    # Cmake file already exist
    if os.path.isfile(cmake_filename):
        # Backup the file
        ProjectCommonRoutines.makeACopy(cmake_filename)
        f = open(cmake_filename)
        data = f.read()
        f.close()
        # Add the class to be removed
        cmake_object = ParseCmakeLists.CMakeLists(data)
        cmake_object.elements_remove_cpp_class = class_name

    # Write new data
    f = open(cmake_filename, 'w')
    f.write(str(cmake_object))
    f.close()


def defineSpecificProgramOptions():
    """
    Define program option(s)
    """
    description = """
    This script allows you to remove all files on disk related to a cpp class
    name.

    WARNING: The script can not remove all dependencies related to the class in
             the <CMakeLists.txt> file. You maybe need to edit it and remove all
             stuff related to this class. Check at least the elements_add_library,
             elements_add_library, find_package and elements_depends_on_subdirs
            macros
    """
    from argparse import RawTextHelpFormatter

    parser = argparse.ArgumentParser(description=description,
                                     formatter_class=RawTextHelpFormatter)
    parser.add_argument('class_name', metavar='class-name',
                        type=str, help='Class name')

    return parser

################################################################################


def mainMethod(args):
    """
    Main
    """

    LOGGER.info('#')
    LOGGER.info('#  Logging from the mainMethod() of the RemoveCppClass script ')
    LOGGER.info('#')

    exit_code = Exit.Code["OK"]

    class_name = args.class_name

    # Default is the current directory
    module_dir = os.getcwd()

    LOGGER.info('Current directory : %s', module_dir)
    LOGGER.info('')

    try:
        # We absolutely need a Elements cmake file
        module_name = ProjectCommonRoutines.getElementsModuleName(module_dir)

        # Default is the current directory
        file_to_be_deleted = getAllFiles(class_name, module_dir, module_name)
        if file_to_be_deleted:
            LOGGER.info('File to be deleted:')
            for elt_file in file_to_be_deleted:
                LOGGER.info('--> %s', elt_file)
            response_key = input('Do you want to continue?(y/n, default: n)')
            if response_key.lower() == 'y':
                ProjectCommonRoutines.removeFilesOnDisk(file_to_be_deleted)
                cmakefile = os.path.join(module_dir, 'CMakeLists.txt')
                updateCmakeListsFile(module_dir, class_name)
                LOGGER.info('')
                LOGGER.warning('# !!!!!!!!!!!!!!!!!!')
                LOGGER.warning('# If your <%s> class has some Element and/or external dependencies,', class_name)
                LOGGER.warning('# Maybe you need to remove them. Check the <elements_add_library, find_package,')
                LOGGER.warning('# elements_add_library, elements_depends_on_subdirs> macros in the file :')
                LOGGER.warning('# < %s >', cmakefile)
                LOGGER.warning('# !!!!!!!!!!!!!!!!!!')
        else:
            LOGGER.info('No file found for deletion!')
            LOGGER.info('')

    except Exception as msg:
        if str(msg):
            LOGGER.error(msg)
        LOGGER.error('# Script aborted.')
        exit_code = Exit.Code["NOT_OK"]
    else:
        LOGGER.info('# Script over.')

    return exit_code