project_helpers

def activeProject():
    """hiero.ui.activeProject() -> returns the current Project

    Note: There is not technically a notion of a "active" Project in Hiero/NukeStudio, as it is a multi-project App.
    This method determines what is "active" by going down the following rules...

    # 1 - If the current Viewer (hiero.ui.currentViewer) contains a Clip or Sequence, this item is assumed to give the active Project
    # 2 - If nothing is currently in the Viewer, look to the active View, determine project from active selection
    # 3 - If no current selection can be determined, fall back to a globally tracked last selection from trackActiveProjectHandler
    # 4 - If all those rules fail, fall back to the last project in the list of hiero.core.projects()

    @return: hiero.core.Project"""
    global gTrackedActiveProject
    activeProject = None

    # Case 1 : Look for what the current Viewr tells us - this might not be what we want, and relies on hiero.ui.currentViewer() being robust.
    cv = hiero.ui.currentViewer().player().sequence()
    if hasattr(cv, "project"):
        activeProject = cv.project()
    else:
        # Case 2: We can't determine a project from the current Viewer, so try seeing what's selected in the activeView
        # Note that currently, if you run activeProject from the Script Editor, the activeView is always None, so this will rarely get used!
        activeView = hiero.ui.activeView()
        if activeView:
            # We can determine an active View.. see what's being worked with
            selection = activeView.selection()

            # Handle the case where nothing is selected in the active view
            if len(selection) == 0:
                # It's possible that there is no selection in a Timeline/Spreadsheet, but these views have "sequence" method, so try that...
                if isinstance(hiero.ui.activeView(), (hiero.ui.TimelineEditor, hiero.ui.SpreadsheetView)):
                    activeSequence = activeView.sequence()
                    if hasattr(currentItem, "project"):
                        activeProject = activeSequence.project()

            # The active view has a selection... assume that the first item in the selection has the active Project
            else:
                currentItem = selection[0]
                if hasattr(currentItem, "project"):
                    activeProject = currentItem.project()

    # Finally, Cases 3 and 4...
    if not activeProject:
        activeProjects = hiero.core.projects(hiero.core.Project.kUserProjects)
        if gTrackedActiveProject in activeProjects:
            activeProject = gTrackedActiveProject
        else:
            activeProject = activeProjects[-1]

    return activeProject

def openRecentProject(k=0):
    """hiero.core.openRecentProject(k) -> Opens the most the recent project as listed in the Open Recent list.

    @param: k (optional, default = 0) - an integer from 0-4, relating to the index of recent projects.
    @return: hiero.core.Project"""

    appSettings = hiero.core.ApplicationSettings()
    proj = appSettings.value('recentFile/%i' % int(k), None)
    proj = hiero.core.openProject(proj)
    return proj

def recentProject(k=0):
    """hiero.core.recentProject(k) -> Returns the recent project path, specified by integer k (0-4)

    @param: k (optional, default = 0) - an integer from 0-4, relating to the index of recent projects.

    @return: hiero.core.Project"""

    appSettings = hiero.core.ApplicationSettings()
    proj = appSettings.value('recentFile/%i' % int(k), None)
    return proj

def recentProjects():
    """hiero.core.recentProjects() -> Returns a list of paths to recently opened projects

    Hiero stores up to 5 recent projects in uistate.ini with the [recentFile]/# key.

    @return: list of paths to .hrox Projects"""

    appSettings = hiero.core.ApplicationSettings()
    recentProjects = []
    for i in range(0, 5):
        proj = appSettings.value('recentFile/%i' % i)
        if len(proj) > 0:
            recentProjects.append(proj)
    return recentProjects