/*****************************************************************************
 *
 * This file is part of Mapnik (c++ mapping toolkit)
 *
 * Copyright (C) 2021 Artem Pavlenko
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *****************************************************************************/

#ifndef MAPNIK_SVG_RENDERER_HPP
#define MAPNIK_SVG_RENDERER_HPP

// mapnik
#include <mapnik/config.hpp>
#include <mapnik/feature_style_processor.hpp>
#include <mapnik/svg/output/svg_generator.hpp>
#include <mapnik/svg/output/svg_output_attributes.hpp>
#include <mapnik/util/noncopyable.hpp>
#include <mapnik/rule.hpp>              // for rule, symbolizers
#include <mapnik/geometry/box2d.hpp>    // for box2d
#include <mapnik/color.hpp>             // for color
#include <mapnik/view_transform.hpp>    // for view_transform
#include <mapnik/image_compositing.hpp> // for composite_mode_e
#include <mapnik/pixel_position.hpp>
#include <mapnik/request.hpp>
#include <mapnik/renderer_common.hpp>
#include <mapnik/util/variant.hpp>
#include <memory>

// stl
#include <string>

// fwd declaration to avoid depedence on agg headers
namespace agg {
struct trans_affine;
}

// fwd declarations to speed up compile
namespace mapnik {
class Map;
class feature_impl;
class feature_type_style;
class label_collision_detector4;
class layer;
struct marker;
class proj_transform;
} // namespace mapnik

namespace mapnik {
// parameterized with the type of output iterator it will use for output.
// output iterators add more flexibility than streams, because iterators
// can target many other output destinations besides streams.
template<typename OutputIterator>
class MAPNIK_DECL svg_renderer : public feature_style_processor<svg_renderer<OutputIterator>>,
                                 private util::noncopyable
{
  public:
    using processor_impl_type = svg_renderer<OutputIterator>;
    svg_renderer(Map const& m,
                 OutputIterator& output_iterator,
                 double scale_factor = 1.0,
                 unsigned offset_x = 0,
                 unsigned offset_y = 0);
    svg_renderer(Map const& m,
                 request const& req,
                 attributes const& vars,
                 OutputIterator& output_iterator,
                 double scale_factor = 1.0,
                 unsigned offset_x = 0,
                 unsigned offset_y = 0);
    ~svg_renderer();

    void start_map_processing(Map const& map);
    void end_map_processing(Map const& map);
    void start_layer_processing(layer const& lay, box2d<double> const& query_extent);
    void end_layer_processing(layer const& lay);
    void start_style_processing(feature_type_style const& /*st*/) {}
    void end_style_processing(feature_type_style const& /*st*/) {}

    /*!
     * @brief Overloads that process each kind of symbolizer individually.
     */
    void process(line_symbolizer const& sym, mapnik::feature_impl& feature, proj_transform const& prj_trans);
    void process(polygon_symbolizer const& sym, mapnik::feature_impl& feature, proj_transform const& prj_trans);
    // unimplemented
    void process(point_symbolizer const&, mapnik::feature_impl&, proj_transform const&) {}
    void process(line_pattern_symbolizer const&, mapnik::feature_impl&, proj_transform const&) {}
    void process(polygon_pattern_symbolizer const&, mapnik::feature_impl&, proj_transform const&) {}
    void process(raster_symbolizer const&, mapnik::feature_impl&, proj_transform const&) {}
    void process(shield_symbolizer const&, mapnik::feature_impl&, proj_transform const&) {}
    void process(text_symbolizer const&, mapnik::feature_impl&, proj_transform const&) {}
    void process(building_symbolizer const&, mapnik::feature_impl&, proj_transform const&) {}
    void process(markers_symbolizer const&, mapnik::feature_impl&, proj_transform const&) {}
    void process(debug_symbolizer const&, mapnik::feature_impl&, proj_transform const&) {}
    void process(group_symbolizer const&, mapnik::feature_impl&, proj_transform const&) {}

    // Overload that process the whole set of symbolizers of a rule.
    // return true, meaning that this renderer can process multiple symbolizers.
    bool process(rule::symbolizers const& syms, mapnik::feature_impl& feature, proj_transform const& prj_trans);

    bool painted() const { return painted_; }

    void painted(bool _painted) { painted_ = _painted; }

    inline eAttributeCollectionPolicy attribute_collection_policy() const { return DEFAULT; }

    inline double scale_factor() const { return common_.scale_factor_; }

    inline attributes const& variables() const { return common_.vars_; }

    inline OutputIterator& get_output_iterator() { return output_iterator_; }

    inline const OutputIterator& get_output_iterator() const { return output_iterator_; }

  private:
    OutputIterator& output_iterator_;
    svg::path_output_attributes path_attributes_;
    svg::svg_generator<OutputIterator> generator_;
    bool painted_;
    renderer_common common_;
};
} // namespace mapnik

#endif // MAPNIK_SVG_RENDERER_HPP
