// Layer.hh for Fluxbox Window Manager
// Copyright (c) 2006 Fluxbox Team (fluxgen at fluxbox dot org)
//
// 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.

#ifndef LAYER_HH
#define LAYER_HH

#include <string>
#include <cstdio>

#ifdef HAVE_CSTRING
  #include <cstring>
#else
  #include <string.h>
#endif

using std::string;

/** 
 * (This is not the layer->raise/lower handling stuff, @see FbTk::Layer)
 * Class to store layer numbers (special Resource type)
 * we have a special resource type because we need to be able to name certain layers
 * a Resource<int> wouldn't allow this
 */
class  Layer {
public:
    enum {
        MENU = 0,
        ABOVE_DOCK = 2,
        DOCK = 4,
        TOP = 6,
        NORMAL = 8,
        BOTTOM = 10,
        DESKTOP = 12,
        NUM_LAYERS = 13
    };

    explicit Layer(int i) : m_num(i) {};

    static int getNumFromString(string &str) {
        int tempnum = 0;
        if (sscanf(str.c_str(), "%d", &tempnum) == 1)
            return tempnum;
        if (strcasecmp(str.c_str(), "Menu") == 0)
            return ::Layer::MENU;
        if (strcasecmp(str.c_str(), "AboveDock") == 0)
            return ::Layer::ABOVE_DOCK;
        if (strcasecmp(str.c_str(), "Dock") == 0)
            return ::Layer::DOCK;
        if (strcasecmp(str.c_str(), "Top") == 0)
            return ::Layer::TOP;
        if (strcasecmp(str.c_str(), "Normal") == 0)
            return ::Layer::NORMAL;
        if (strcasecmp(str.c_str(), "Bottom") == 0)
            return ::Layer::BOTTOM;
        if (strcasecmp(str.c_str(), "Desktop") == 0)
            return ::Layer::DESKTOP;
        return -1;
    }

    static string getString(int num) {
        switch (num) {
        case ::Layer::MENU:
            return string("Menu");
        case ::Layer::ABOVE_DOCK:
            return string("AboveDock");
        case ::Layer::DOCK:
            return string("Dock");
        case ::Layer::TOP:
            return string("Top");
        case ::Layer::NORMAL:
            return string("Normal");
        case ::Layer::BOTTOM:
            return string("Bottom");
        case ::Layer::DESKTOP:
            return string("Desktop");
        default:
            char tmpstr[128];
            sprintf(tmpstr, "%d", num);
            return string(tmpstr);
        }
    }

    int getNum() const { return m_num; }
    string getString() const { return getString(m_num); }

    Layer &operator=(int num) { m_num = num; return *this; }

private:
    int m_num;
};

#endif // LAYER_HH