fix doxygen warnings

[wxWidgets.git] / utils / screenshotgen / src / autocapture.cpp

/////////////////////////////////////////////////////////////////////////////
// Name:        autocapture.cpp
// Purpose:     Implement wxCtrlMaskOut class
// Author:      Utensil Candel (UtensilCandel@@gmail.com)
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

// For compilers that support precompilation, includes "wx/wx.h".
#include "wx/wxprec.h"

#ifdef __BORLANDC__
    #pragma hdrstop
#endif

// for all others, include the necessary headers
#ifndef WX_PRECOMP
    #include "wx/wx.h"
#endif

#include <wx/filename.h>
#include "autocapture.h"


// ----------------------------------------------------------------------------
// AutoCaptureMechanism
// ----------------------------------------------------------------------------

/* static */
wxBitmap AutoCaptureMechanism::Capture(int x, int y, int width, int height)
{
    // Somehow wxScreenDC.Blit() doesn't work under Mac for now. Here is a trick.
#ifdef __WXMAC__

    // wxExecute(_T("screencapture -x ") + tempfile, wxEXEC_SYNC);

    system("screencapture -x /tmp/wx_screen_capture.png");

    wxBitmap fullscreen;

    do
    {
        fullscreen = wxBitmap(_T("/tmp/wx_screen_capture.png"), wxBITMAP_TYPE_PNG);
    }
    while(!fullscreen.IsOk());

    wxBitmap screenshot = fullscreen.GetSubBitmap(wxRect(x,y,width,height));

#else // Under other paltforms, take a real screenshot

    // Create a DC for the whole screen area
    wxScreenDC dcScreen;

    // Create a Bitmap that will later on hold the screenshot image
    // Note that the Bitmap must have a size big enough to hold the screenshot
    // -1 means using the current default colour depth
    wxBitmap screenshot(width, height, -1);

    // Create a memory DC that will be used for actually taking the screenshot
    wxMemoryDC memDC;

    // Tell the memory DC to use our Bitmap
    // all drawing action on the memory DC will go to the Bitmap now
    memDC.SelectObject(screenshot);

    // Blit (in this case copy) the actual screen on the memory DC
    // and thus the Bitmap
    memDC.Blit( 0, // Copy to this X coordinate
                0, // Copy to this Y coordinate
                width, // Copy this width
                height, // Copy this height
                &dcScreen, // From where do we copy?
                x, // What's the X offset in the original DC?
                y  // What's the Y offset in the original DC?
              );

    // Select the Bitmap out of the memory DC by selecting a new
    // uninitialized Bitmap
    memDC.SelectObject(wxNullBitmap);
#endif // #ifdef __WXMAC__

    return screenshot;
}

/* static */
wxBitmap AutoCaptureMechanism::Capture(wxRect rect)
{
    wxPoint origin = rect.GetPosition();
    return Capture(origin.x, origin.y, rect.GetWidth(), rect.GetHeight());
}

void AutoCaptureMechanism::CaptureAll()
{
    // start from the first page
    m_notebook->SetSelection(0);
    wxYield();

    for (ControlList::iterator it = m_controlList.begin();
         it != m_controlList.end();
         ++it)
    {
        Control &ctrl = *it;

        if (ctrl.flag == AJ_TurnPage)    // Turn to next page
        {
            m_notebook->SetSelection(m_notebook->GetSelection() + 1);
            wxYield();
            continue;
        }

        // create the screenshot
        wxBitmap screenshot = Capture(ctrl);
        if (ctrl.flag & AJ_Union)
            screenshot = Union(screenshot, Capture(*(++it)));

        // and save it
        Save(screenshot, ctrl.name);
    }
}

wxBitmap AutoCaptureMechanism::Capture(Control& ctrl)
{
    if (ctrl.name == wxT(""))  // no manual specification for the control name
    {
        // Get its name from wxRTTI
        ctrl.name = ctrl.ctrl->GetClassInfo()->GetClassName();
    }

    int choice = wxNO;

    // for drop-down controls we need the help of the user
    if (ctrl.flag & AJ_Dropdown)
    {
        wxString caption = _("Drop-down screenshot...");
        wxString msg =
            wxString::Format(_("Do you wish to capture the drop-down list of '%s' ?\n\nIf you click YES you must drop-down the list of '%s' in 3 seconds after closing this message box.\nIf you click NO the screenshot for this control won't contain its drop-down list."),
                             ctrl.name, ctrl.name);

        choice = wxMessageBox(msg, caption, wxYES_NO, m_notebook);
        if (choice == wxYES)
        {
            using std::clock;
            using std::clock_t;

            // Wait for 3 seconds
            clock_t start = clock();
            while (clock() - start < CLOCKS_PER_SEC * 3)
                wxYieldIfNeeded();
        }
    }

    wxRect rect = GetRect(ctrl.ctrl, ctrl.flag);

    // Do some rect adjust so it can include the dropdown list;
    // currently this only works well under MSW; not adjusted for Linux and Mac OS
    if (ctrl.flag & AJ_Dropdown && choice == wxYES)
    {
//          #ifdef __WXMSW__
        int h = rect.GetHeight();
        rect.SetHeight(h * 4);
//          #endif
    }

    // cut off "wx" and change the name into lowercase.
    // e.g. wxButton will have a name of "button" at the end
    ctrl.name.StartsWith(_T("wx"), &(ctrl.name));
    ctrl.name.MakeLower();

    // take the screenshot
    wxBitmap screenshot = Capture(rect);

    if (ctrl.flag & AJ_RegionAdjust)
        PutBack(ctrl.ctrl);

    return screenshot;
}

wxBitmap AutoCaptureMechanism::Union(wxBitmap pic1, wxBitmap pic2)
{
    int w1, w2, h1, h2, w, h;
    w1 = pic1.GetWidth();
    w2 = pic2.GetWidth();
    h1 = pic1.GetHeight();
    h2 = pic2.GetHeight();

    const int gap_between = 20;

    w = (w1 >= w2) ? w1 : w2;
    h = h1 + h2 + gap_between;

    wxBitmap result(w, h, -1);

    wxMemoryDC dstDC;
    dstDC.SelectObject(result);

    dstDC.DrawBitmap(pic1, 0, 0, false);
    dstDC.DrawBitmap(pic2, 0, h1 + gap_between, false);

    dstDC.SelectObject(wxNullBitmap);

    wxMemoryDC maskDC;
    wxBitmap mask(w, h, 1);
    maskDC.SelectObject(mask);

    maskDC.SetPen(*wxTRANSPARENT_PEN);
    maskDC.SetBrush(*wxBLACK_BRUSH);
    maskDC.DrawRectangle(0, 0, w + 1, h + 1);

    maskDC.SetBrush(*wxWHITE_BRUSH);
    maskDC.DrawRectangle(0, 0, w1, h1);
    maskDC.DrawRectangle(0, h1 + gap_between, w2, h2);
    maskDC.SelectObject(wxNullBitmap);

    result.SetMask(new wxMask(mask));

    return result;
}

void AutoCaptureMechanism::Save(wxBitmap screenshot, wxString fileName)
{
    // make sure m_dir exists
    if (!wxDirExists(m_dir))
        wxMkdir(m_dir);

    wxFileName fullFileName(m_dir, fileName + ".png");

    // do not overwrite already existing files with this name
    while (fullFileName.FileExists())
        fullFileName.SetName(fullFileName.GetName() + "_");

    // save the screenshot as a PNG
    screenshot.SaveFile(fullFileName.GetFullPath(), wxBITMAP_TYPE_PNG);
}

wxRect AutoCaptureMechanism::GetRect(wxWindow* ctrl, int flag)
{
    if (flag & AJ_RegionAdjust)
    {
        wxWindow * parent = ctrl->GetParent();
        wxSizer * sizer = parent->GetSizer();

        if (sizer)
        {
            sizer->Detach(ctrl);

            /*
            +---------+-----------+---------+
            |    0    |   label   |    1    |
            +---------+-----------+---------+
            |  label  |    ctrl   |  label  |
            +---------+-----------+---------+
            |    2    |   label   |    3    |
            +---------+-----------+---------+
           */

            m_grid = new wxFlexGridSizer(3, 3, m_border, m_border);

            wxStaticText* l[4];

            for (int i = 0; i < 4; ++i)
                l[i] = new wxStaticText(parent, wxID_ANY, wxT(" "));

            m_grid->Add(l[0]);
            m_grid->Add(new wxStaticText(parent, wxID_ANY, wxT(" ")));
            m_grid->Add(l[1]);
            m_grid->Add(new wxStaticText(parent, wxID_ANY, wxT(" ")));
            m_grid->Add(ctrl);
            m_grid->Add(new wxStaticText(parent, wxID_ANY, wxT(" ")));
            m_grid->Add(l[2]);
            m_grid->Add(new wxStaticText(parent, wxID_ANY, wxT(" ")));
            m_grid->Add(l[3]);

            sizer->Add(m_grid);
            parent->SetSizer(sizer);
            parent->Layout();

            parent->Refresh();
            wxYield();

            return wxRect(l[0]->GetScreenRect().GetBottomRight(),
                    l[3]->GetScreenRect().GetTopLeft());

        }
        else  // Actually it won't get here working with the current guiframe.h/guiframe.cpp
        {
            return ctrl->GetScreenRect().Inflate(m_border);
        }
    }
    else
    {
       return ctrl->GetScreenRect().Inflate(m_border);
    }
}

void AutoCaptureMechanism::PutBack(wxWindow * ctrl)
{
    m_grid->Detach(ctrl);

    wxSizerItemList children = m_grid->GetChildren();

    for (wxSizerItemList::iterator it = children.begin(); it != children.end(); ++it)
    {
        wxSizerItem* item = *it;
        if (item->IsWindow()) delete (*it)->GetWindow();
    }

    wxSizer * sizer = ctrl->GetParent()->GetSizer();
    sizer->Detach(m_grid);
    delete m_grid;
    sizer->Add(ctrl);
}