# R overlay -- config package, const
# -*- coding: utf-8 -*-
# Copyright (C) 2012 André Erdmann <dywi@mailerd.de>
# Distributed under the terms of the GNU General Public License;
# either version 2 of the License, or (at your option) any later version.

"""defines constants"""

import copy
import time

__all__ = [ 'clone', 'lookup' ]

_CONSTANTS = dict (
   debug          = False,
   nosync         = False,
   #sync_in_hooks = None,
   #installed     = False,

   portdir = '/usr/portage',

   INSTALLINFO = dict (
      # FIXME: rename key
      libexec          = '/usr/share/roverlay', # ::DATA_ROOT::
      confroot         = '/etc/roverlay', # ::CONF_ROOT::
      workroot         = '~/roverlay', # ::WORK_ROOT::
   ),

   config_file_name = "R-overlay.conf",

   # logging defaults are in recipe/easylogger

   DESCRIPTION = dict (
      field_separator       = ':',
      comment_chars         = '#;',
      list_split_regex      = '\s*[,;]{1}\s*',
      file_name             = 'DESCRIPTION',
   ),

   R_PACKAGE = dict (
      suffix_regex       = '[.](tgz|tbz2|tar|(tar[.](gz|bz2)))',
      name_ver_separator = '_',
   ),

   EBUILD = dict (
      default_header = (
         '# Copyright 1999-{year:d} Gentoo Foundation\n'
         '# Distributed under the terms of the GNU General Public License v2\n'
         '# $Header: $\n'
      ).format ( year=time.gmtime()[0] ),
      # EAPI=N and inherit <eclasses> are no longer part of the default header
      eapi = 5,

      # number of workers used by OverlayCreator
      # when 0    => dont use threads
      # otherwise => use N threads
      jobcount = 0,

      USE_EXPAND = dict (
         name   = 'R_SUGGESTS',
      ),
   ),

   DEPRES = dict (
      # number of dependency resolution workers
      # when 0    => dont use threads
      # otherwise => use K threads resulting in a depres speedup of < K
      #
      #  Note: an ebuild creation job usually needs to resolve more than one
      #         dependency, so setting K > N may be advantageous.
      #         OTOH, a depres job takes considerably less time than
      #         ebuild creation.
      #
      jobcount = 0,
   ),

   LOG = dict (
      CONSOLE = dict (
         enabled = True,
      ),
   ),

   OVERLAY = dict (
      name                    = 'R_Overlay',
      category                = 'sci-R',
      manifest_implementation = 'default',
      masters                 = [ 'gentoo', ],
   ),

   REPO = dict (
      websync_timeout = 10,
   ),

   LICENSEMAP = dict (
      use_portdir = True,
   ),

   EVENT_HOOK = dict (
      default_exe_relpath = [ 'hooks', 'mux.sh' ],
   ),

   TOOLS = dict (
      EBUILD = dict (
         exe    = "/usr/bin/ebuild",
      ),
      PATCH = dict (
         exe    = "patch",
         opts   = (
            '--no-backup-if-mismatch',
            '--reject-file=-',
            '--verbose',
            # '--quiet', # '--force',
         )
      ),
   ),

   RRD_DB = dict (
      step = 7200,
   ),
)

def lookup ( key, fallback_value=None ):
   """Looks up a constant. See config.get (...) for details.
   Returns constant if found else None.
   """
   path = key.split ( '.' )

   const_position = _CONSTANTS

   for k in path:
      if k in const_position:
         const_position = const_position [k]
      else:
         return fallback_value

   return const_position

def clone ( ):
   """Returns a deep copy of the constants."""
   return copy.deepcopy ( _CONSTANTS )