|
Packit Service |
e3b512 |
/* Copyright (C) 2014 The cairomm Development Team
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* This library is free software; you can redistribute it and/or
|
|
Packit Service |
e3b512 |
* modify it under the terms of the GNU Library General Public
|
|
Packit Service |
e3b512 |
* License as published by the Free Software Foundation; either
|
|
Packit Service |
e3b512 |
* version 2 of the License, or (at your option) any later version.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* This library is distributed in the hope that it will be useful,
|
|
Packit Service |
e3b512 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
Packit Service |
e3b512 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Packit Service |
e3b512 |
* Library General Public License for more details.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* You should have received a copy of the GNU Library General Public
|
|
Packit Service |
e3b512 |
* License along with this library; if not, write to the Free Software
|
|
Packit Service |
e3b512 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
Packit Service |
e3b512 |
* 02110-1301, USA.
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
#ifndef __CAIROMM_SCRIPT_H
|
|
Packit Service |
e3b512 |
#define __CAIROMM_SCRIPT_H
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
#include <string>
|
|
Packit Service |
e3b512 |
#include <cairomm/device.h>
|
|
Packit Service |
e3b512 |
#include <cairomm/surface.h> // SlotWriteFunc
|
|
Packit Service |
e3b512 |
#include <cairomm/enums.h>
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
#ifdef CAIRO_HAS_SCRIPT_SURFACE
|
|
Packit Service |
e3b512 |
#include <cairo-script.h>
|
|
Packit Service |
e3b512 |
#endif
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
namespace Cairo {
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
#ifdef CAIRO_HAS_SCRIPT_SURFACE
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
class ScriptSurface;
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/**
|
|
Packit Service |
e3b512 |
* A set of script output variants for the script surface.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @since 1.12
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
enum ScriptMode {
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/// The output will be in readable text (default).
|
|
Packit Service |
e3b512 |
SCRIPT_MODE_ASCII = CAIRO_SCRIPT_MODE_ASCII,
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/// The output will use byte codes.
|
|
Packit Service |
e3b512 |
SCRIPT_MODE_BINARY = CAIRO_SCRIPT_MODE_BINARY
|
|
Packit Service |
e3b512 |
};
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/**
|
|
Packit Service |
e3b512 |
* The script surface provides the ability to render to a native script that
|
|
Packit Service |
e3b512 |
* matches the cairo drawing model. The scripts can be replayed using tools under
|
|
Packit Service |
e3b512 |
* the util/cairo-script directoriy, or with cairo-perf-trace.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @since 1.12
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
class Script : public Device {
|
|
Packit Service |
e3b512 |
public:
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/**
|
|
Packit Service |
e3b512 |
* Create a C++ wrapper for the C instance. This C++ instance should then be
|
|
Packit Service |
e3b512 |
* given to a RefPtr.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @param cobject The C instance.
|
|
Packit Service |
e3b512 |
* @param has_reference whether we already have a reference. Otherwise, the
|
|
Packit Service |
e3b512 |
* constructor will take an extra reference.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @since 1.12
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
explicit Script(cairo_device_t* cobject, bool has_reference = false);
|
|
Packit Service |
e3b512 |
virtual ~Script();
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/**
|
|
Packit Service |
e3b512 |
* Converts the record operations in recording_surface into a script.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @param recording_surface The recording surface to replay
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* Throws an exception on error.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @since 1.12
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
void add_from_recording_surface(const RefPtr<ScriptSurface>& recording_surface);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/**
|
|
Packit Service |
e3b512 |
* Queries the script for its current output mode.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @since 1.12
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
ScriptMode get_mode() const;
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/**
|
|
Packit Service |
e3b512 |
* Change the output mode of the script.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @param mode The new mode.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @since 1.12
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
void set_mode(ScriptMode new_mode);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/**
|
|
Packit Service |
e3b512 |
* Emit a string verbatim into the script.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @param comment The string to emit
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
void write_comment(const std::string& comment);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/**
|
|
Packit Service |
e3b512 |
* Creates a output device for emitting the script, used when creating the
|
|
Packit Service |
e3b512 |
* individual surfaces.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @param filename The name (path) of the file to write the script to.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* Throws an exception on error.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @since 1.12
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
static RefPtr<Script> create(const std::string& filename);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
/**
|
|
Packit Service |
e3b512 |
* Creates a output device for emitting the script, used when creating the
|
|
Packit Service |
e3b512 |
* individual surfaces.
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @param write_func Callback function passed the bytes written to the script
|
|
Packit Service |
e3b512 |
*
|
|
Packit Service |
e3b512 |
* @since 1.12
|
|
Packit Service |
e3b512 |
*/
|
|
Packit Service |
e3b512 |
static RefPtr<Script> create_for_stream(const Surface::SlotWriteFunc& write_func);
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
};
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
#endif // CAIRO_HAS_SCRIPT_SURFACE
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
} // namespace Cairo
|
|
Packit Service |
e3b512 |
|
|
Packit Service |
e3b512 |
#endif //__CAIROMM_SCRIPT_SURFACE_H
|
|
Packit Service |
e3b512 |
|