# *****************************************************************************
# Written by Ritchie Lee, ritchie.lee@sv.cmu.edu
# *****************************************************************************
# Copyright ã 2015, United States Government, as represented by the
# Administrator of the National Aeronautics and Space Administration. All
# rights reserved.  The Reinforcement Learning Encounter Simulator (RLES)
# platform is licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License. You
# may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable
# law or agreed to in writing, software distributed under the License is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the specific language
# governing permissions and limitations under the License.
# _____________________________________________________________________________
# Reinforcement Learning Encounter Simulator (RLES) includes the following
# third party software. The SISLES.jl package is licensed under the MIT Expat
# License: Copyright (c) 2014: Youngjun Kim.
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
# "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
# NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# *****************************************************************************

module TikzUtils

export add_to_document!, use_geometry_package!, use_aircraftshapes_package!, wrap_tikzpicture!,
    lualatex_compile

using TikzPictures
using RLESUtils, FileUtils

function add_to_document!(d::TikzDocument, tp::TikzPicture, cap::AbstractString) 
    push!(d, tp, caption=cap)
end

function add_to_document!(d::TikzDocument,tps::Array{TikzPicture,1},cap::AbstractString) 
    [add_to_document!(d,tp,cap) for tp in tps]
end

function add_to_document!{T<:AbstractString}(d::TikzDocument,tpsTups::Array{Tuple{TikzPicture,T},1}) 
    [add_to_document!(d,tps...) for tps in tpsTups]
end

function add_to_document!{T<:AbstractString}(d::TikzDocument, 
    tpsTups::Array{Tuple{Vector{TikzPicture},T},1})  
    [add_to_document!(d,tps...) for tps in tpsTups]
end

function use_geometry_package!(p::TikzPicture; margin::Float64 = 0.5, landscape::Bool = false)
    # Adds margin enforcement to pdf file
    # Adds capability for landscape
    # margin in inches
    # landscape false is portrait
    orientation_str = landscape ? ",landscape" : ""
    #prepend geometry package
    p.preamble = "\\usepackage[margin=$(margin)in" * orientation_str * "]{geometry}\n" * p.preamble
    p
end

function use_aircraftshapes_package!(p::TikzPicture)
    #prepend aircraftshape package
    p.preamble = "\\usepackage{aircraftshapes}\n" * p.preamble
    p
end

function wrap_tikzpicture!(texfile::AbstractString, pre::AbstractString, post::AbstractString)
    foldername = dirname(texfile)
    if isempty(foldername)
        foldername = "."
    end
    begintikz = "\\begin{tikzpicture}"
    endtikz = "\\end{tikzpicture}"
    replace_text(texfile, begintikz, pre * begintikz, foldername, fopen=open, inplace=true) 
    replace_text(texfile, endtikz, endtikz * post, foldername, fopen=open, inplace=true) 
end

function lualatex_compile(texfile::AbstractString)
    foldername = dirname(texfile)
    if isempty(foldername)
        foldername = "."
    end
    cmd = `lualatex --output-directory=$(foldername) $(texfile)`
    success(cmd)
end

end #module
