utils/screenshotgen/src/autocapture.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        autocapture.cpp
   3 // Purpose:     Implement wxCtrlMaskOut class
   4 // Author:      Utensil Candel (UtensilCandel@@gmail.com)
   5 // Licence:     wxWindows licence
   6 /////////////////////////////////////////////////////////////////////////////
   7
   8 // For compilers that support precompilation, includes "wx/wx.h".
   9 #include "wx/wxprec.h"
  10
  11 #ifdef __BORLANDC__
  12 #pragma hdrstop
  13 #endif
  14
  15 #include "autocapture.h"
  16
  17 #ifndef WX_PRECOMP
  18 #include "wx/wx.h"
  19 #endif
  20
  21 #include "wx/bitmap.h"
  22 #include "wx/filename.h"
  23 #include "wx/notebook.h"
  24
  25 #include <ctime>
  26
  27 #ifdef __WXMAC__
  28 #include <cstring>
  29 #endif
  30
  31
  32 // ----------------------------------------------------------------------------
  33 // AutoCaptureMechanism
  34 // ----------------------------------------------------------------------------
  35
  36 AutoCaptureMechanism::AutoCaptureMechanism(wxNotebook *notebook,
  37                                            int flag, int margin)
  38 : m_notebook(notebook),
  39   m_flag(flag),
  40   m_margin(margin),
  41   m_grid(NULL)
  42 {
  43 }
  44
  45 /* static */
  46 wxString AutoCaptureMechanism::default_dir = wxT("screenshots");
  47
  48 /* static */
  49 wxString AutoCaptureMechanism::GetDefaultDirectoryAbsPath()
  50 {
  51     wxFileName output = wxFileName::DirName(GetDefaultDirectory());
  52     output.MakeAbsolute();
  53     return output.GetFullPath();
  54 }
  55
  56 /* static */
  57 void AutoCaptureMechanism::Delay(int seconds)
  58 {
  59     // TODO: Switch this to use wxTimer.
  60
  61     // Wait for 3 seconds
  62     clock_t start = clock();
  63     while ( clock() - start < (clock_t)CLOCKS_PER_SEC * seconds)
  64         wxYieldIfNeeded();
  65 }
  66
  67 /* static */
  68 bool AutoCaptureMechanism::Capture(wxBitmap* bitmap, int x, int y,
  69                                    int width, int height, int delay)
  70 {
  71     // Somehow wxScreenDC.Blit() doesn't work under Mac for now. Here is a trick.
  72 #ifdef __WXMAC__
  73
  74     // wxExecute(wxT("screencapture -x ") + tempfile, wxEXEC_SYNC);
  75
  76     char captureCommand[80] =""; // a reasonable max size is 80
  77     sprintf(captureCommand, "sleep %d;%s", delay, "screencapture -x /tmp/wx_screen_capture.png");
  78     system(captureCommand);
  79
  80     if(delay) Delay(delay);
  81
  82     wxBitmap fullscreen;
  83     do
  84     {
  85         fullscreen = wxBitmap(wxT("/tmp/wx_screen_capture.png"), wxBITMAP_TYPE_PNG);
  86     }
  87     while(!fullscreen.IsOk());
  88
  89     *bitmap = fullscreen.GetSubBitmap(wxRect(x, y, width, height));
  90
  91     // to prevent loading the old screenshot next time
  92     system("rm /tmp/wx_screen_capture.png");
  93
  94     return true;
  95
  96 #else // Under other paltforms, take a real screenshot
  97
  98     if(delay) Delay(delay);
  99
 100     // Create a DC for the whole screen area
 101     wxScreenDC dcScreen;
 102
 103     bitmap->Create(width, height);
 104
 105     // Create a memory DC that will be used for actually taking the screenshot
 106     wxMemoryDC memDC;
 107     memDC.SelectObject((*bitmap));
 108     memDC.Clear();
 109
 110     // Blit (in this case copy) the actual screen on the memory DC
 111     // and thus the Bitmap
 112     memDC.Blit( 0, // Copy to this X coordinate
 113                 0, // Copy to this Y coordinate
 114                 width, // Copy this width
 115                 height, // Copy this height
 116                 &dcScreen, // From where do we copy?
 117                 x, // What's the X offset in the original DC?
 118                 y  // What's the Y offset in the original DC?
 119               );
 120
 121     // Select the Bitmap out of the memory DC by selecting a new
 122     // uninitialized Bitmap
 123     memDC.SelectObject(wxNullBitmap);
 124 #endif // #ifdef __WXMAC__
 125
 126     return true;
 127 }
 128
 129 /* static */
 130 bool AutoCaptureMechanism::Capture(wxBitmap* bitmap, wxRect rect, int delay)
 131 {
 132     wxPoint origin = rect.GetPosition();
 133     return Capture(bitmap, origin.x, origin.y, rect.GetWidth(), rect.GetHeight(), delay);
 134 }
 135
 136 /* static */
 137 void AutoCaptureMechanism::Save(wxBitmap* screenshot, const wxString& fileName)
 138 {
 139     // make sure default_dir exists
 140     if (!wxDirExists(default_dir))
 141         wxMkdir(default_dir);
 142
 143     wxFileName fullFileName(default_dir, "appear-" + fileName +
 144         "-" + wxPlatformInfo::Get().GetPortIdShortName() + ".png");
 145
 146     // do not overwrite already existing files with this name
 147     while (fullFileName.FileExists())
 148         fullFileName.SetName(fullFileName.GetName() + "_");
 149
 150     // save the screenshot as a PNG
 151     screenshot->SaveFile(fullFileName.GetFullPath(), wxBITMAP_TYPE_PNG);
 152 }
 153
 154 void AutoCaptureMechanism::CaptureAll()
 155 {
 156     // start from the first page
 157     m_notebook->SetSelection(0);
 158     wxYield();
 159
 160     for (ControlList::iterator it = m_controlList.begin();
 161          it != m_controlList.end();
 162          ++it)
 163     {
 164         Control &ctrl = *it;
 165
 166         if (ctrl.flag == AJ_TurnPage)    // Turn to next page
 167         {
 168             m_notebook->SetSelection(m_notebook->GetSelection() + 1);
 169             wxYield();
 170             continue;
 171         }
 172
 173         // create the screenshot
 174         wxBitmap screenshot(1, 1);
 175         Capture(&screenshot, ctrl);
 176
 177         if(ctrl.flag & AJ_Union)
 178         {
 179             // union screenshots until AJ_UnionEnd
 180             do
 181             {
 182                 ++it;
 183                 it->name = ctrl.name; //preserving the name
 184                 wxBitmap screenshot2(1, 1);
 185                 Capture(&screenshot2, *it);
 186                 wxBitmap combined(1, 1);
 187                 Union(&screenshot, &screenshot2, &combined);
 188                 screenshot = combined;
 189             }
 190             while(!(it->flag & AJ_UnionEnd));
 191         }
 192
 193         // and save it
 194         Save(&screenshot, ctrl.name);
 195     }
 196 }
 197
 198 bool AutoCaptureMechanism::Capture(wxBitmap* bitmap, Control& ctrl)
 199 {
 200     // no manual specification for the control name
 201     // or name adjustment is disabled globally
 202     if (ctrl.name == wxT("") || m_flag & AJ_DisableNameAdjust)
 203     {
 204         // Get its name from wxRTTI
 205         ctrl.name = ctrl.ctrl->GetClassInfo()->GetClassName();
 206     }
 207
 208     int choice = wxNO;
 209
 210     wxRect rect = GetRect(ctrl.ctrl, ctrl.flag);
 211
 212     if (ctrl.flag & AJ_Dropdown && !(m_flag & AJ_DisableDropdown))
 213     {
 214         // for drop-down controls we need the help of the user
 215         wxString caption = _("Drop-down screenshot...");
 216         wxString msg =
 217             wxString::Format(_("Do you wish to capture the drop-down list of '%s' ?\n\n If YES, please drop down the list of '%s' in 5 seconds after closing this message box.\n If NO, the screenshot for this control won't contain its drop-down list."),
 218                              ctrl.name, ctrl.name);
 219
 220         choice = wxMessageBox(msg, caption, wxYES_NO, m_notebook);
 221
 222         if (choice == wxYES)
 223         {
 224             //A little hint
 225             ctrl.ctrl->SetCursor(wxCursor(wxCURSOR_HAND));
 226
 227             // Do some rect adjust so it can include the dropdown list
 228             // This adjust isn't pretty, but it works fine on all three paltforms.
 229             // Looking forward to a better solution
 230             int h = rect.GetHeight();
 231             rect.SetHeight(h * 4);
 232         }
 233     }
 234
 235     // cut off "wx" and change the name into lowercase.
 236     // e.g. wxButton will have a name of "button" at the end
 237     ctrl.name.StartsWith(wxT("wx"), &(ctrl.name));
 238     ctrl.name.MakeLower();
 239
 240     // take the screenshot
 241     Capture(bitmap, rect, (choice == wxYES)?5:0);
 242
 243     if (choice == wxYES) ctrl.ctrl->SetCursor(wxNullCursor);
 244
 245     if (ctrl.flag & AJ_RegionAdjust)
 246         PutBack(ctrl.ctrl);
 247
 248     return true;
 249 }
 250
 251 /* static */
 252 bool AutoCaptureMechanism::Union(wxBitmap* top, wxBitmap* bottom, wxBitmap* result)
 253 {
 254     int w1, w2, h1, h2, w, h;
 255     w1 = top->GetWidth();
 256     w2 = bottom->GetWidth();
 257     h1 = top->GetHeight();
 258     h2 = bottom->GetHeight();
 259
 260     const int gap_between = 20;
 261
 262     w = (w1 >= w2) ? w1 : w2;
 263     h = h1 + h2 + gap_between;
 264
 265     result->Create(w, h);
 266
 267     wxMemoryDC dstDC;
 268     dstDC.SelectObject((*result));
 269
 270     dstDC.SetBrush(*wxWHITE_BRUSH);
 271     dstDC.Clear();
 272     dstDC.DrawBitmap((*top), 0, 0);
 273     dstDC.DrawBitmap((*bottom), 0, h1 + gap_between);
 274
 275     dstDC.SelectObject(wxNullBitmap);
 276
 277     return true;
 278 }
 279
 280 wxRect AutoCaptureMechanism::GetRect(wxWindow* ctrl, int flag)
 281 {
 282     if( (!(m_flag & AJ_DisableRegionAdjust) && (flag & AJ_RegionAdjust))
 283         || (m_flag & AJ_AlwaysRegionAdjust) )
 284     {
 285         wxWindow * parent = ctrl->GetParent();
 286         wxSizer * sizer = parent->GetSizer();
 287
 288         //The assertion won't fail if controls are still managed by wxSizer, and it's unlikely to
 289         //change in the future.
 290         wxASSERT_MSG(sizer,
 291         "The GUI that AutoCaptureMechanism working with doesn't manage controls with wxSizer");
 292
 293         sizer->Detach(ctrl);
 294
 295         /*
 296         +---------+-----------+---------+
 297         |    0    |   label   |    1    |
 298         +---------+-----------+---------+
 299         |  label  |    ctrl   |  label  |
 300         +---------+-----------+---------+
 301         |    2    |   label   |    3    |
 302         +---------+-----------+---------+
 303        */
 304
 305         m_grid = new wxFlexGridSizer(3, 3, m_margin, m_margin);
 306
 307         wxStaticText* l[4];
 308
 309         for (int i = 0; i < 4; ++i)
 310             l[i] = new wxStaticText(parent, wxID_ANY, wxT(" "));
 311
 312         m_grid->Add(l[0]);
 313         m_grid->Add(new wxStaticText(parent, wxID_ANY, wxT(" ")));
 314         m_grid->Add(l[1]);
 315         m_grid->Add(new wxStaticText(parent, wxID_ANY, wxT(" ")));
 316         m_grid->Add(ctrl, 1, wxEXPAND);
 317         m_grid->Add(new wxStaticText(parent, wxID_ANY, wxT(" ")));
 318         m_grid->Add(l[2]);
 319         m_grid->Add(new wxStaticText(parent, wxID_ANY, wxT(" ")));
 320         m_grid->Add(l[3]);
 321
 322         sizer->Add(m_grid);
 323         parent->SetSizer(sizer);
 324         parent->Layout();
 325
 326         parent->Refresh();
 327         wxYield();
 328
 329         return wxRect(l[0]->GetScreenRect().GetBottomRight(),
 330                 l[3]->GetScreenRect().GetTopLeft());
 331     }
 332     else
 333     {
 334        return ctrl->GetScreenRect().Inflate(m_margin);
 335     }
 336 }
 337
 338 void AutoCaptureMechanism::PutBack(wxWindow * ctrl)
 339 {
 340     if(!m_grid) return;
 341
 342     m_grid->Detach(ctrl);
 343
 344     wxSizerItemList children = m_grid->GetChildren();
 345
 346     for (wxSizerItemList::iterator it = children.begin(); it != children.end(); ++it)
 347     {
 348         wxSizerItem* item = *it;
 349         if (item->IsWindow()) delete (*it)->GetWindow();
 350     }
 351
 352     wxSizer * sizer = ctrl->GetParent()->GetSizer();
 353
 354     //The assertion won't fail if controls are still managed by wxSizer, and it's unlikely to
 355     //change in the future.
 356     wxASSERT_MSG(sizer,
 357     "The GUI that AutoCaptureMechanism working with doesn't manage controls with wxSizer");
 358
 359     sizer->Detach(m_grid);
 360     delete m_grid;
 361     m_grid = NULL;
 362
 363     sizer->Add(ctrl);
 364 }
 365