eclipse.py

#
# Copyright (c) 2006-2022, RT-Thread Development Team
#
# SPDX-License-Identifier: Apache-2.0
#
# Change Logs:
# Date           Author       Notes
# 2019-03-21     Bernard      the first version
# 2019-04-15     armink       fix project update error
# 2025-09-01     wdfk-prog    Add project-name support for Eclipse target and enhance folder linking
#

import glob
import xml.etree.ElementTree as etree
from xml.etree.ElementTree import SubElement

from . import rt_studio
import sys
import os

# Add parent directory to path to import building and utils
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
from building import *
from utils import *
from utils import _make_path_relative
from utils import xml_indent

MODULE_VER_NUM = 6

source_pattern = ['*.c', '*.cpp', '*.cxx', '*.cc', '*.s', '*.S', '*.asm','*.cmd']


def OSPath(path):
    import platform

    if type(path) == type('str'):
        if platform.system() == 'Windows':
            return path.replace('/', '\\')
        else:
            return path.replace('\\', '/')
    else:
        if platform.system() == 'Windows':
            return [item.replace('/', '\\') for item in path]
        else:
            return [item.replace('\\', '/') for item in path]


# collect the build source code path and parent path
def CollectPaths(paths):
    all_paths = []

    def ParentPaths(path):
        ret = os.path.dirname(path)
        if ret == path or ret == '':
            return []

        return [ret] + ParentPaths(ret)

    for path in paths:
        # path = os.path.abspath(path)
        path = path.replace('\\', '/')
        all_paths = all_paths + [path] + ParentPaths(path)

    cwd = os.getcwd()
    for path in os.listdir(cwd):
        temp_path = cwd.replace('\\', '/') + '/' + path
        if os.path.isdir(temp_path):
            all_paths = all_paths + [temp_path]

    all_paths = list(set(all_paths))
    return sorted(all_paths)


'''
Collect all of files under paths
'''


def CollectFiles(paths, pattern):
    files = []
    for path in paths:
        if type(pattern) == type(''):
            files = files + glob.glob(path + '/' + pattern)
        else:
            for item in pattern:
                # print('--> %s' % (path + '/' + item))
                files = files + glob.glob(path + '/' + item)

    return sorted(files)


def CollectAllFilesinPath(path, pattern):
    files = []

    for item in pattern:
        files += glob.glob(path + '/' + item)

    list = os.listdir(path)
    if len(list):
        for item in list:
            if item.startswith('.'):
                continue
            if item == 'bsp':
                continue

            if os.path.isdir(os.path.join(path, item)):
                files = files + CollectAllFilesinPath(os.path.join(path, item), pattern)
    return files


'''
Exclude files from infiles
'''


def ExcludeFiles(infiles, files):
    in_files = set([OSPath(file) for file in infiles])
    exl_files = set([OSPath(file) for file in files])

    exl_files = in_files - exl_files

    return exl_files


# caluclate the exclude path for project
def ExcludePaths(rootpath, paths):
    ret = []

    files = os.listdir(OSPath(rootpath))
    for file in files:
        if file.startswith('.'):
            continue

        fullname = os.path.join(OSPath(rootpath), file)

        if os.path.isdir(fullname):
            # print(fullname)
            if not fullname in paths:
                ret = ret + [fullname]
            else:
                ret = ret + ExcludePaths(fullname, paths)

    return ret


rtt_path_prefix = '"${workspace_loc://${ProjName}//'


def ConverToRttEclipsePathFormat(path):
    return rtt_path_prefix + path + '}"'


def IsRttEclipsePathFormat(path):
    if path.startswith(rtt_path_prefix):
        return True
    else:
        return False


# all libs added by scons should be ends with five whitespace as a flag
rtt_lib_flag = 5 * " "


def ConverToRttEclipseLibFormat(lib):
    return str(lib) + str(rtt_lib_flag)


def IsRttEclipseLibFormat(path):
    if path.endswith(rtt_lib_flag):
        return True
    else:
        return False


def IsCppProject():
    return GetDepend('RT_USING_CPLUSPLUS')


def HandleToolOption(tools, env, project, reset):
    is_cpp_prj = IsCppProject()
    BSP_ROOT = os.path.abspath(env['BSP_ROOT'])

    CPPDEFINES = project['CPPDEFINES']
    paths = [ConverToRttEclipsePathFormat(RelativeProjectPath(env, os.path.normpath(i)).replace('\\', '/')) for i in project['CPPPATH']]

    compile_include_paths_options = []
    compile_include_files_options = []
    compile_defs_options = []
    linker_scriptfile_option = None
    linker_script_option = None
    linker_nostart_option = None
    linker_libs_option = None
    linker_paths_option = None

    linker_newlib_nano_option = None

    for tool in tools:

        if tool.get('id').find('compile') != 1:
            options = tool.findall('option')
            # find all compile options
            for option in options:
                option_id = option.get('id')
                if ('compiler.include.paths' in  option_id) or ('compiler.option.includepaths' in  option_id) or ('compiler.tasking.include' in  option_id):
                    compile_include_paths_options += [option]
                elif option.get('id').find('compiler.include.files') != -1 or option.get('id').find('compiler.option.includefiles') != -1 :
                    compile_include_files_options += [option]
                elif option.get('id').find('compiler.defs') != -1 or option.get('id').find('compiler.option.definedsymbols') != -1:
                    compile_defs_options += [option]

        if tool.get('id').find('linker') != -1:
            options = tool.findall('option')
            # find all linker options
            for option in options:
                # the project type and option type must equal
                if is_cpp_prj != (option.get('id').find('cpp.linker') != -1):
                    continue

                if option.get('id').find('linker.scriptfile') != -1:
                    linker_scriptfile_option = option
                elif option.get('id').find('linker.option.script') != -1:
                    linker_script_option = option
                elif option.get('id').find('linker.nostart') != -1:
                    linker_nostart_option = option
                elif option.get('id').find('linker.libs') != -1:
                    linker_libs_option = option
                elif option.get('id').find('linker.paths') != -1 and 'LIBPATH' in env:
                    linker_paths_option = option
                elif option.get('id').find('linker.usenewlibnano') != -1:
                    linker_newlib_nano_option = option

    # change the inclue path
    for option in compile_include_paths_options:
        # find all of paths in this project
        include_paths = option.findall('listOptionValue')
        for item in include_paths:
            if reset is True or IsRttEclipsePathFormat(item.get('value')) :
                # clean old configuration
                option.remove(item)
        # print('c.compiler.include.paths')
        paths = sorted(paths)
        for item in paths:
            SubElement(option, 'listOptionValue', {'builtIn': 'false', 'value': item})
    # change the inclue files (default) or definitions
    for option in compile_include_files_options:
        # add '_REENT_SMALL' to CPPDEFINES when --specs=nano.specs has select
        if linker_newlib_nano_option is not None and linker_newlib_nano_option.get('value') == 'true' and '_REENT_SMALL' not in CPPDEFINES:
            CPPDEFINES += ['_REENT_SMALL']

        file_header = '''
#ifndef RTCONFIG_PREINC_H__
#define RTCONFIG_PREINC_H__

/* Automatically generated file; DO NOT EDIT. */
/* RT-Thread pre-include file */

'''
        file_tail = '\n#endif /*RTCONFIG_PREINC_H__*/\n'
        rtt_pre_inc_item = '"${workspace_loc:/${ProjName}/rtconfig_preinc.h}"'
        # save the CPPDEFINES in to rtconfig_preinc.h
        with open('rtconfig_preinc.h', mode = 'w+') as f:
            f.write(file_header)
            for cppdef in CPPDEFINES:
                f.write("#define " + cppdef.replace('=', ' ') + '\n')
            f.write(file_tail)
        #  change the c.compiler.include.files
        files = option.findall('listOptionValue')
        find_ok = False
        for item in files:
            if item.get('value') == rtt_pre_inc_item:
                find_ok = True
                break
        if find_ok is False:
            SubElement(option, 'listOptionValue', {'builtIn': 'false', 'value': rtt_pre_inc_item})
    if len(compile_include_files_options) == 0:
        for option in compile_defs_options:
            defs = option.findall('listOptionValue')
            project_defs = []
            for item in defs:
                if reset is True:
                    # clean all old configuration
                    option.remove(item)
                else:
                    project_defs += [item.get('value')]
            if len(project_defs) > 0:
                cproject_defs = set(CPPDEFINES) - set(project_defs)
            else:
                cproject_defs = CPPDEFINES

            # print('c.compiler.defs')
            cproject_defs = sorted(cproject_defs)
            for item in cproject_defs:
                SubElement(option, 'listOptionValue', {'builtIn': 'false', 'value': item})

    # update linker script config
    if linker_scriptfile_option is not None :
        option = linker_scriptfile_option
        linker_script = 'link.lds'
        items = env['LINKFLAGS'].split(' ')
        if '-T' in items:
            linker_script = items[items.index('-T') + 1]
            linker_script = ConverToRttEclipsePathFormat(linker_script)

        listOptionValue = option.find('listOptionValue')
        if listOptionValue != None:
            if reset is True or IsRttEclipsePathFormat(listOptionValue.get('value')):
                listOptionValue.set('value', linker_script)
        else:
            SubElement(option, 'listOptionValue', {'builtIn': 'false', 'value': linker_script})
    # scriptfile in stm32cubeIDE
    if linker_script_option is not None :
        option = linker_script_option
        items = env['LINKFLAGS'].split(' ')
        if '-T' in items:
            linker_script = ConverToRttEclipsePathFormat(items[items.index('-T') + 1]).strip('"')
            option.set('value', linker_script)
    # update nostartfiles config
    if linker_nostart_option is not None :
        option = linker_nostart_option
        if env['LINKFLAGS'].find('-nostartfiles') != -1:
            option.set('value', 'true')
        else:
            option.set('value', 'false')
    # update libs
    if linker_libs_option is not None:
        option = linker_libs_option
        # remove old libs
        for item in option.findall('listOptionValue'):
            if IsRttEclipseLibFormat(item.get("value")):
                option.remove(item)

        # add new libs
        if 'LIBS' in env:
            for lib in env['LIBS']:
                lib_name = os.path.basename(str(lib))
                if lib_name.endswith('.a'):
                    if lib_name.startswith('lib'):
                        lib = lib_name[3:].split('.')[0]
                    else:
                        lib = ':' + lib_name
                formatedLib = ConverToRttEclipseLibFormat(lib)
                SubElement(option, 'listOptionValue', {
                           'builtIn': 'false', 'value': formatedLib})

    # update lib paths
    if linker_paths_option is not None:
        option = linker_paths_option
        # remove old lib paths
        for item in option.findall('listOptionValue'):
            if IsRttEclipsePathFormat(item.get('value')):
                # clean old configuration
                option.remove(item)
        # add new old lib paths
        for path in env['LIBPATH']:
            SubElement(option, 'listOptionValue', {'builtIn': 'false', 'value': ConverToRttEclipsePathFormat(RelativeProjectPath(env, path).replace('\\', '/'))})

    return

def UpdateProjectStructure(env, prj_name):
    """
    Updates the .project file to link any external/specified folders from 
    PROJECT_SOURCE_FOLDERS in rtconfig.py. This version correctly handles
    all specified paths, regardless of their physical location.
    """
    bsp_root = os.path.abspath(env['BSP_ROOT'])
    
    # --- 1. Read the list of folders to be linked from rtconfig.py ---
    folders_to_link = []
    try:
        import rtconfig
        if hasattr(rtconfig, 'PROJECT_SOURCE_FOLDERS') and rtconfig.PROJECT_SOURCE_FOLDERS:
            folders_to_link = rtconfig.PROJECT_SOURCE_FOLDERS
    except ImportError:
        pass # It's okay if the file or variable doesn't exist.

    if not os.path.exists('.project'):
        print("Error: .project file not found. Cannot update.")
        return
        
    project_xml = etree.parse('.project')
    root = project_xml.getroot()

    # --- 2. Ensure the <linkedResources> node exists ---
    linkedResources = root.find('linkedResources')
    if linkedResources is None:
        linkedResources = SubElement(root, 'linkedResources')

    # --- 3. Clean up previously managed links to prevent duplicates ---
    managed_link_names = [os.path.basename(p) for p in folders_to_link]
    for link in list(linkedResources.findall('link')): # Use list() to safely remove items while iterating
        name_element = link.find('name')
        if name_element is not None and name_element.text in managed_link_names:
            linkedResources.remove(link)
            print(f"Removed existing linked resource '{name_element.text}' to regenerate it.")

    # --- 4. Create new links for each folder specified by the user ---
    for folder_path in folders_to_link:
        # The link name in the IDE will be the directory's base name.
        link_name = os.path.basename(folder_path)
        
        # Resolve the absolute path of the folder to be linked.
        abs_folder_path = os.path.abspath(os.path.join(bsp_root, folder_path))

        print(f"Creating linked resource for '{link_name}' pointing to '{abs_folder_path}'...")

        # Calculate the URI relative to the Eclipse ${PROJECT_LOC} variable.
        # This works for both internal and external folders.
        relative_link_path = os.path.relpath(abs_folder_path, bsp_root).replace('\\', '/')
        
        # Use Eclipse path variables for robustness. PARENT_LOC is more standard for external folders.
        if relative_link_path.startswith('../'):
             # Count how many levels up
            levels_up = relative_link_path.count('../')
            clean_path = relative_link_path.replace('../', '')
            location_uri = f'PARENT-{levels_up}-PROJECT_LOC/{clean_path}'
        else:
            location_uri = f'PROJECT_LOC/{relative_link_path}'
            
        link_element = SubElement(linkedResources, 'link')
        SubElement(link_element, 'name').text = link_name
        SubElement(link_element, 'type').text = '2' # Type 2 means a folder link.
        SubElement(link_element, 'locationURI').text = location_uri

    # --- 5. Write the updated content back to the .project file ---
    out = open('.project', 'w', encoding='utf-8')
    out.write('<?xml version="1.0" encoding="UTF-8"?>\n')
    xml_indent(root)
    out.write(etree.tostring(root, encoding='utf-8').decode('utf-8'))
    out.close()

    return


def GenExcluding(env, project):
    rtt_root = os.path.abspath(env['RTT_ROOT'])
    bsp_root = os.path.abspath(env['BSP_ROOT'])
    coll_dirs = CollectPaths(project['DIRS'])
    all_paths_temp = [OSPath(path) for path in coll_dirs]
    all_paths = []

    # add used path
    for path in all_paths_temp:
        if path.startswith(rtt_root) or path.startswith(bsp_root):
            all_paths.append(path)

    if bsp_root.startswith(rtt_root):
        # bsp folder is in the RT-Thread root folder, such as the RT-Thread source code on GitHub
        exclude_paths = ExcludePaths(rtt_root, all_paths)
    elif rtt_root.startswith(bsp_root):
        # RT-Thread root folder is in the bsp folder, such as project folder which generate by 'scons --dist' cmd
        check_path = []
        exclude_paths = []
        # analyze the primary folder which relative to BSP_ROOT and in all_paths
        for path in all_paths:
            if path.startswith(bsp_root):
                folders = RelativeProjectPath(env, path).split('\\')
                if folders[0] != '.' and '\\' + folders[0] not in check_path:
                    check_path += ['\\' + folders[0]]
        # exclue the folder which has managed by scons
        for path in check_path:
            exclude_paths += ExcludePaths(bsp_root + path, all_paths)
    else:
        exclude_paths = ExcludePaths(rtt_root, all_paths)
        exclude_paths += ExcludePaths(bsp_root, all_paths)

    paths = exclude_paths
    exclude_paths = []
    # remove the folder which not has source code by source_pattern
    for path in paths:
        # add bsp and libcpu folder and not collect source files (too more files)
        if path.endswith('rt-thread\\bsp') or path.endswith('rt-thread\\libcpu'):
            exclude_paths += [path]
            continue

        set = CollectAllFilesinPath(path, source_pattern)
        if len(set):
            exclude_paths += [path]

    exclude_paths = [RelativeProjectPath(env, path).replace('\\', '/') for path in exclude_paths]

    all_files = CollectFiles(all_paths, source_pattern)
    src_files = project['FILES']

    exclude_files = ExcludeFiles(all_files, src_files)
    exclude_files = [RelativeProjectPath(env, file).replace('\\', '/') for file in exclude_files]

    env['ExPaths'] = exclude_paths
    env['ExFiles'] = exclude_files

    return exclude_paths + exclude_files


def RelativeProjectPath(env, path):
    project_root = os.path.abspath(env['BSP_ROOT'])
    rtt_root = os.path.abspath(env['RTT_ROOT'])

    if path.startswith(project_root):
        return _make_path_relative(project_root, path)

    if path.startswith(rtt_root):
        return 'rt-thread/' + _make_path_relative(rtt_root, path)

    # TODO add others folder
    print('ERROR: the ' + path + ' not support')

    return path


def HandleExcludingOption(entry, sourceEntries, excluding):
    old_excluding = []
    if entry != None:
        exclud = entry.get('excluding')
        if exclud != None:
            old_excluding = entry.get('excluding').split('|')
            sourceEntries.remove(entry)

    value = ''
    for item in old_excluding:
        if item.startswith('//'):
            old_excluding.remove(item)
        else:
            if value == '':
                value = item
            else:
                value += '|' + item

    for item in excluding:
        # add special excluding path prefix for RT-Thread
        item = '//' + item
        if value == '':
            value = item
        else:
            value += '|' + item

    SubElement(sourceEntries, 'entry', {'excluding': value, 'flags': 'VALUE_WORKSPACE_PATH|RESOLVED', 'kind':'sourcePath', 'name':""})

def UpdateProjectName(prj_name):
    """
    Regardless of whether the .project file exists, make sure its name is correct.
    """
    if not prj_name:
        return

    try:
        if not os.path.exists('.project'):
            if rt_studio.gen_project_file(os.path.abspath(".project"), prj_name) is False:
                print('Fail!')
                return
            print("Generated .project file with name:", prj_name)

        project_tree = etree.parse('.project')
        root = project_tree.getroot()
        name_element = root.find('name')
        
        if name_element is not None and name_element.text != prj_name:
            print(f"Updating project name from '{name_element.text}' to '{prj_name}'...")
            name_element.text = prj_name
            
            project_tree.write('.project', encoding='UTF-8', xml_declaration=True)
            xml_indent(root) 
            with open('.project', 'w', encoding='utf-8') as f:
                 f.write('<?xml version="1.0" encoding="UTF-8"?>\n')
                 f.write(etree.tostring(root, encoding='utf-8').decode('utf-8'))
            
    except Exception as e:
        print("Error updating .project file:", e)

def HandleSourceEntries_Global(sourceEntries, excluding):
    """
    Configure the project to include the root folder ("") and exclude all 
    files/folders in the 'excluding' list. This makes all project folders 
    visible in the IDE.
    """
    # To keep the configuration clean, first remove all existing entries
    for entry in sourceEntries.findall('entry'):
        sourceEntries.remove(entry)

    # Join the exclusion list into a single string with the '|' separator
    excluding_str = '|'.join(sorted(excluding))

    # Create a new, single entry for the project root directory
    SubElement(sourceEntries, 'entry', {
        'flags': 'VALUE_WORKSPACE_PATH|RESOLVED',
        'kind': 'sourcePath',
        'name': "",  # An empty string "" represents the project root
        'excluding': excluding_str
    })

def UpdateCproject(env, project, excluding, reset, prj_name):
    excluding = sorted(excluding)

    cproject = etree.parse('.cproject')

    root = cproject.getroot()
    cconfigurations = root.findall('storageModule/cconfiguration')
    for cconfiguration in cconfigurations:
        tools = cconfiguration.findall('storageModule/configuration/folderInfo/toolChain/tool')
        HandleToolOption(tools, env, project, reset)

        if prj_name:
            config_element = cconfiguration.find('storageModule/configuration')
            if config_element is not None:
                config_element.set('artifactName', prj_name)

        sourceEntries = cconfiguration.find('storageModule/configuration/sourceEntries')
        if sourceEntries is not None:
            # Call the new global handler function for source entries
            HandleSourceEntries_Global(sourceEntries, excluding)
            
    # update refreshScope to ensure the project refreshes correctly
    if prj_name:
        prj_name_for_path = '/' + prj_name
        configurations = root.findall('storageModule/configuration')
        for configuration in configurations:
            resource = configuration.find('resource')
            if resource is not None:
                configuration.remove(resource)
            SubElement(configuration, 'resource', {'resourceType': "PROJECT", 'workspacePath': prj_name_for_path})

    # write back to .cproject file
    out = open('.cproject', 'w')
    out.write('<?xml version="1.0" encoding="UTF-8" standalone="no"?>\n')
    out.write('<?fileVersion 4.0.0?>')
    xml_indent(root)
    out.write(etree.tostring(root, encoding='utf-8').decode('utf-8'))
    out.close()

def TargetEclipse(env, project, reset=False, prj_name=None):
    global source_pattern

    UpdateProjectName(prj_name)

    print('Update eclipse setting...')

    # generate cproject file
    if not os.path.exists('.cproject'):
        if rt_studio.gen_cproject_file(os.path.abspath(".cproject")) is False:
            print('Fail!')
            return

    # generate project file
    if not os.path.exists('.project'):
        if rt_studio.gen_project_file(os.path.abspath(".project")) is False:
            print('Fail!')
            return

    # generate projcfg.ini file
    if not os.path.exists('.settings/projcfg.ini'):
    # if search files with uvprojx or uvproj suffix
        file = ""
        items = os.listdir(".")
        if len(items) > 0:
            for item in items:
                if item.endswith(".uvprojx") or item.endswith(".uvproj"):
                    file = os.path.abspath(item)
                    break
        chip_name = rt_studio.get_mcu_info(file)
        if rt_studio.gen_projcfg_ini_file(chip_name, prj_name, os.path.abspath(".settings/projcfg.ini")) is False:
            print('Fail!')
            return

    # enable lowwer .s file compiled in eclipse cdt
    if not os.path.exists('.settings/org.eclipse.core.runtime.prefs'):
        if rt_studio.gen_org_eclipse_core_runtime_prefs(
            os.path.abspath(".settings/org.eclipse.core.runtime.prefs")) is False:
            print('Fail!')
            return

    # add clean2 target to fix issues when files too many
    if not os.path.exists('makefile.targets'):
        if rt_studio.gen_makefile_targets(os.path.abspath("makefile.targets")) is False:
            print('Fail!')
            return

    # update the project file structure info on '.project' file
    UpdateProjectStructure(env, prj_name)

    # generate the exclude paths and files
    excluding = GenExcluding(env, project)

    # update the project configuration on '.cproject' file
    UpdateCproject(env, project, excluding, reset, prj_name)

    print('done!')

    return