Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/ScriptableController/src/libraries/util/Clipboard.cc @ 10012

Last change on this file since 10012 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 3.7 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 *   Windows version inspired by "Copy Text To Clipboard" by Laszlo Szathmary, 2007
28 *      http://www.loria.fr/~szathmar/off/projects/C/CopyTextToClipboard/index.php
29 */
30
31/**
32    @file
33    @brief OS-specific implementations of the clipboard functions.
34*/
35
36#include "Clipboard.h"
37
38#ifdef ORXONOX_PLATFORM_WINDOWS
39
40/////////////
41// Windows //
42/////////////
43
44#ifndef WIN32_LEAN_AND_MEAN
45#  define WIN32_LEAN_AND_MEAN
46#endif
47#include <windows.h>
48#undef min
49#undef max
50#include "Output.h"
51
52namespace orxonox
53{
54
55    /**
56        @brief Puts text into the Windows-clipboard
57        @return True if the action was successful
58    */
59    bool toClipboard(const std::string& text)
60    {
61        try
62        {
63            if (OpenClipboard(0))
64            {
65                EmptyClipboard();
66                HGLOBAL clipbuffer = GlobalAlloc(GMEM_DDESHARE, text.size() + 1);
67                char* buffer = static_cast<char*>(GlobalLock(clipbuffer));
68                strcpy(buffer, text.c_str());
69                GlobalUnlock(clipbuffer);
70                SetClipboardData(CF_TEXT, clipbuffer);
71                CloseClipboard();
72
73                return true;
74            }
75        }
76        catch (...)
77        {
78            orxout(user_error) << "Unable to copy the following text to the clipboard:" << endl;
79            orxout(user_error) << '"' << text << '"' << endl;
80        }
81        return false;
82    }
83
84    /**
85        @brief Gets text from the windows-clipboard if there is any text.
86        @return The retrieved text
87    */
88    std::string fromClipboard()
89    {
90        try
91        {
92            if (OpenClipboard(0))
93            {
94                HANDLE hData = GetClipboardData(CF_TEXT);
95                if (hData == NULL)
96                    return "";
97                std::string output(static_cast<char*>(GlobalLock(hData)));
98                GlobalUnlock(hData);
99                CloseClipboard();
100
101                return output;
102            }
103        }
104        catch (...)
105        {
106            orxout(user_error) << "Unable to retrieve text from the clipboard." << endl;
107        }
108        return "";
109    }
110}
111
112#else /* ORXONOX_PLATFORM_WINDOWS */
113
114/////////////
115// Default //
116/////////////
117
118namespace orxonox
119{
120    static std::string clipboard; ///< Keeps the text of our internal clipboard
121
122    /**
123        @brief Default implementation if there is no OS-specific implementation or no clipboard. Copies the text into an internal clipboard.
124        @see fromClipboard()
125    */
126    bool toClipboard(const std::string& text)
127    {
128        clipboard = text;
129        return true;
130    }
131
132    /**
133        @brief Default implementation if there is no OS-specific implementation or no clipboard. Gets the text from the internal clipboard.
134        @see toClipboard()
135    */
136    std::string fromClipboard()
137    {
138        return clipboard;
139    }
140}
141
142#endif /* ORXONOX_PLATFORM_WINDOWS */
Note: See TracBrowser for help on using the repository browser.