"""
Copyright 2008 Free Software Foundation, Inc.
This file is part of GNU Radio

GNU Radio Companion is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

GNU Radio Companion 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
"""
##@package grc_gnuradio.Platform
#Gnuradio python specific platform.
#@author Josh Blum

import os
from grc.Constants import FLOW_GRAPH_FILE_EXTENSION
from grc.elements.Platform import Platform as _Platform
from FlowGraph import FlowGraph as _FlowGraph
from Connection import Connection as _Connection
from Block import Block as _Block
from Port import Source,Sink
from Param import Param as _Param
from Generator import Generator
from Constants import *

class Platform(_Platform):

	def __init__(self, block_paths_internal_only=[], block_paths_external=[]):
		"""!
		Make a platform for gnuradio.
		The internal only list will replace the current block path.
		@param block_paths_internal_only a list of blocks internal to this platform
		@param block_paths_external a list of blocks to load in addition to the above blocks
		"""
		#ensure hier dir
		if not os.path.exists(HIER_BLOCKS_LIB_DIR): os.mkdir(HIER_BLOCKS_LIB_DIR)
		#handle internal/only
		if block_paths_internal_only: 
			block_paths = map(lambda b: os.path.join(BLOCKS_DIR, b), ['options.xml'] + block_paths_internal_only)
		else: block_paths = [BLOCKS_DIR]
		#handle external
		block_paths.extend(block_paths_external)
		#append custom hiers
		block_paths.append(HIER_BLOCKS_LIB_DIR)
		#init
		_Platform.__init__(
			self,
			name='GNURadio Python',
			key='gnuradio_python',
			block_paths=block_paths,
			block_dtd=BLOCK_DTD,
			block_tree=BLOCK_TREE,
			default_flow_graph=DEFAULT_FLOW_GRAPH,
			generator=Generator,
		)

	##############################################
	# Constructors
	##############################################
	FlowGraph = _FlowGraph
	Connection = _Connection
	Block = _Block
	Source = Source
	Sink = Sink
	Param = _Param