KiCad PCB EDA Suite
bitmap_store.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the
8  * Free Software Foundation, either version 3 of the License, or (at your
9  * option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #include <wx/bitmap.h>
21 #include <wx/filename.h>
22 #include <wx/log.h>
23 #include <wx/mstream.h>
24 #include <wx/stdpaths.h>
25 
26 #include <advanced_config.h>
27 #include <asset_archive.h>
28 #include <bitmaps.h>
29 #include <bitmap_store.h>
30 #include <bitmaps/bitmap_info.h>
31 #include <kiplatform/ui.h>
32 #include <paths.h>
33 #include <pgm_base.h>
35 
36 
38 static const unsigned char s_imageNotFound[] = {
39  0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a, 0x00, 0x00, 0x00, 0x0d, 0x49, 0x48, 0x44, 0x52,
40  0x00, 0x00, 0x00, 0x18, 0x00, 0x00, 0x00, 0x18, 0x08, 0x04, 0x00, 0x00, 0x00, 0x4a, 0x7e, 0xf5,
41  0x73, 0x00, 0x00, 0x01, 0xab, 0x49, 0x44, 0x41, 0x54, 0x38, 0xcb, 0x8d, 0xd4, 0x3f, 0x2c, 0x03,
42  0x51, 0x18, 0x00, 0xf0, 0x4b, 0x0c, 0x22, 0xb1, 0x19, 0x8c, 0x46, 0x09, 0x62, 0x60, 0x68, 0x62,
43  0x20, 0xb1, 0x98, 0x24, 0x24, 0x77, 0x08, 0xd2, 0x10, 0x03, 0x06, 0x8b, 0x90, 0x98, 0x48, 0x25,
44  0x3a, 0x34, 0x12, 0xb1, 0x19, 0x0c, 0xa2, 0x34, 0xfe, 0xc4, 0x24, 0x29, 0x93, 0xa1, 0x0c, 0x52,
45  0x7f, 0xe2, 0xcf, 0x20, 0x5a, 0x83, 0xa1, 0xb4, 0xf7, 0xa7, 0x77, 0xef, 0xde, 0xdd, 0xd3, 0xde,
46  0xd1, 0x7e, 0x7a, 0x17, 0xda, 0xe2, 0xb5, 0xee, 0x7d, 0xdb, 0x7d, 0xdf, 0xef, 0xde, 0xbb, 0xfb,
47  0xde, 0x7b, 0x0c, 0x0b, 0x6c, 0xfa, 0x77, 0x70, 0x46, 0x9f, 0x69, 0x05, 0x67, 0xfe, 0xc9, 0x01,
48  0xc3, 0xa6, 0x99, 0xa2, 0xa1, 0xb5, 0x8b, 0x81, 0xa4, 0x9a, 0x20, 0xf7, 0xca, 0x39, 0x0a, 0x2b,
49  0x11, 0x84, 0x0c, 0xe1, 0x20, 0x55, 0x57, 0xc8, 0xe7, 0xaa, 0x0b, 0x80, 0xb4, 0xf0, 0x77, 0xcf,
50  0xda, 0x7a, 0x66, 0x02, 0xd8, 0x7c, 0xb8, 0x61, 0xf3, 0x3d, 0x89, 0x71, 0x1b, 0x15, 0x68, 0x4d,
51  0xb2, 0x31, 0x54, 0x54, 0xfc, 0x1d, 0x0b, 0x20, 0x21, 0x5c, 0x43, 0x01, 0x0c, 0x23, 0x04, 0xd7,
52  0x3f, 0x58, 0x98, 0x85, 0x7d, 0xf3, 0x46, 0x89, 0xa2, 0x4b, 0xe4, 0xfb, 0x22, 0xc1, 0x94, 0x32,
53  0x4f, 0x05, 0x7a, 0xb3, 0xf0, 0xf6, 0xa8, 0x4a, 0xbc, 0xb2, 0xa8, 0x77, 0x91, 0x56, 0xdc, 0x2b,
54  0x3e, 0x2f, 0x67, 0x2d, 0xe0, 0x81, 0x78, 0x98, 0x0a, 0x18, 0x46, 0xf1, 0xe0, 0x1e, 0xa8, 0xc8,
55  0xbf, 0x60, 0xf8, 0x04, 0x5b, 0x60, 0x06, 0x12, 0xd1, 0x12, 0xe0, 0xe7, 0x10, 0xd7, 0x02, 0xa6,
56  0x05, 0xbc, 0x10, 0x0f, 0x39, 0x00, 0xc9, 0xf9, 0x17, 0x32, 0x62, 0x7f, 0xc3, 0x99, 0xae, 0x4d,
57  0xfd, 0x03, 0xa0, 0x52, 0xdc, 0x79, 0xd0, 0xc7, 0xec, 0xf2, 0xd5, 0x8c, 0x14, 0x83, 0xaa, 0xb2,
58  0x40, 0xa8, 0x16, 0xaf, 0x4f, 0x89, 0xf5, 0x8b, 0x39, 0xf0, 0x9b, 0xa2, 0x80, 0xeb, 0xa9, 0x7d,
59  0x28, 0x02, 0x87, 0xc7, 0x29, 0x2e, 0x57, 0x3e, 0x08, 0x21, 0x22, 0xde, 0xea, 0xb5, 0x25, 0x3a,
60  0x9d, 0x6f, 0x60, 0x43, 0x9c, 0x0c, 0xd8, 0xe5, 0x8f, 0xba, 0xb4, 0x0d, 0x95, 0xc5, 0x39, 0x3a,
61  0x18, 0x3f, 0x22, 0xd6, 0xda, 0x77, 0x0d, 0x69, 0xeb, 0x77, 0x8e, 0x0a, 0xd4, 0x85, 0xbd, 0xac,
62  0x3b, 0xb7, 0x8b, 0x2e, 0x54, 0xdc, 0xed, 0x08, 0xe0, 0x39, 0xf9, 0xcd, 0x0a, 0x45, 0xd7, 0x3a,
63  0x1d, 0x81, 0x72, 0xa3, 0x04, 0x50, 0x5d, 0xc8, 0x2b, 0xfb, 0xb4, 0x0e, 0x87, 0x40, 0x19, 0x7d,
64  0xd5, 0xfd, 0x99, 0x8d, 0x6c, 0x4c, 0x4b, 0x4e, 0x3b, 0x02, 0x7c, 0x6c, 0xc6, 0xee, 0xf0, 0x64,
65  0xee, 0x1c, 0x38, 0x02, 0x32, 0x71, 0xdb, 0xa0, 0x1f, 0xd4, 0x8f, 0xc2, 0xce, 0x2d, 0x37, 0xc3,
66  0xd5, 0x8a, 0x7d, 0x0a, 0x96, 0x80, 0x7f, 0x72, 0x34, 0x83, 0xd6, 0x28, 0xf1, 0x4f, 0x28, 0x82,
67  0x24, 0x59, 0x75, 0xd1, 0x00, 0xe5, 0x9a, 0xb1, 0x2e, 0x1a, 0xce, 0xa0, 0x3d, 0x67, 0xe1, 0x13,
68  0xb5, 0xc5, 0x7e, 0xb7, 0x69, 0x08, 0x53, 0x5c, 0x00, 0x00, 0x00, 0x00, 0x49, 0x45, 0x4e, 0x44,
69  0xae, 0x42, 0x60, 0x82,
70 };
71 
72 
75 static const unsigned char s_dummyItem[] = {
76  0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a, 0x00, 0x00, 0x00, 0x0d, 0x49, 0x48, 0x44, 0x52,
77  0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x10, 0x08, 0x06, 0x00, 0x00, 0x00, 0x1f, 0xf3, 0xff,
78  0x61, 0x00, 0x00, 0x00, 0x5f, 0x49, 0x44, 0x41, 0x54, 0x38, 0xcb, 0x63, 0xf8, 0xff, 0xff, 0x3f,
79  0x03, 0x25, 0x98, 0x61, 0x68, 0x1a, 0x00, 0x04, 0x46, 0x40, 0xfc, 0x02, 0x88, 0x45, 0x41, 0x1c,
80  0x76, 0x20, 0xfe, 0x01, 0xc4, 0xbe, 0x24, 0x18, 0x60, 0x01, 0xc4, 0x20, 0x86, 0x04, 0x88, 0xc3,
81  0x01, 0xe5, 0x04, 0x0c, 0xb8, 0x01, 0x37, 0x81, 0xf8, 0x04, 0x91, 0xf8, 0x0a, 0x54, 0x8f, 0x06,
82  0xb2, 0x01, 0x9b, 0x81, 0x78, 0x02, 0x91, 0x78, 0x05, 0x54, 0x8f, 0xca, 0xe0, 0x08, 0x03, 0x36,
83  0xa8, 0xbf, 0xec, 0xc8, 0x32, 0x80, 0xcc, 0x84, 0x04, 0x0a, 0xbc, 0x1d, 0x40, 0x2c, 0xc8, 0x30,
84  0xf4, 0x33, 0x13, 0x00, 0x6b, 0x1a, 0x46, 0x7b, 0x68, 0xe7, 0x0f, 0x0b, 0x00, 0x00, 0x00, 0x00,
85  0x49, 0x45, 0x4e, 0x44, 0xae, 0x42, 0x60, 0x82,
86 };
87 
88 
89 static const wxString traceBitmaps = wxT( "KICAD_BITMAPS" );
90 
91 static const wxString IMAGE_ARCHIVE = wxT( "images.tar.gz" );
92 
93 
94 size_t std::hash<std::pair<BITMAPS, int>>::operator()( const std::pair<BITMAPS, int>& aPair ) const
95 {
96  return std::hash<int>()( static_cast<int>( aPair.first ) ^ std::hash<int>()( aPair.second ) );
97 }
98 
99 
101 {
102  wxFileName path( PATHS::GetStockDataPath() + wxT( "/resources" ), IMAGE_ARCHIVE );
103 
104  wxLogTrace( traceBitmaps, "Loading bitmaps from " + path.GetFullPath() );
105 
106  m_archive = std::make_unique<ASSET_ARCHIVE>( path.GetFullPath() );
107 
109 
110  ThemeChanged();
111 }
112 
113 
114 wxBitmap BITMAP_STORE::GetBitmap( BITMAPS aBitmapId, int aHeight )
115 {
116  return wxBitmap( getImage( aBitmapId, aHeight ) );
117 }
118 
119 
120 wxBitmap BITMAP_STORE::GetBitmapScaled( BITMAPS aBitmapId, int aScaleFactor, int aHeight )
121 {
122  wxImage image = getImage( aBitmapId, aHeight );
123 
124  // Bilinear seems to genuinely look better for these line-drawing icons
125  // than bicubic, despite claims in the wx documentation that bicubic is
126  // "highest quality". I don't recommend changing this. Bicubic looks
127  // blurry and makes me want an eye exam.
128  image.Rescale( aScaleFactor * image.GetWidth() / 4, aScaleFactor * image.GetHeight() / 4,
129  wxIMAGE_QUALITY_BILINEAR );
130 
131  return wxBitmap( image );
132 }
133 
134 
135 wxImage BITMAP_STORE::getImage( BITMAPS aBitmapId, int aHeight )
136 {
137  const unsigned char* data = nullptr;
138  long count;
139 
140  if( aBitmapId == BITMAPS::dummy_item )
141  {
142  data = s_dummyItem;
143  count = sizeof( s_dummyItem );
144  }
145  else
146  {
147  count = m_archive->GetFilePointer( bitmapName( aBitmapId, aHeight ), &data );
148 
149  if( count < 0 )
150  {
151  wxLogTrace( traceBitmaps, "Bitmap for %d, %d, %s has an info tag with file %s,"
152  "but that file could not be found in the archive!",
153  aBitmapId, aHeight, m_theme );
154  data = s_imageNotFound;
155  count = sizeof( s_imageNotFound );
156  }
157  }
158 
159  wxMemoryInputStream is( data, count );
160  wxImage image( is, wxBITMAP_TYPE_PNG );
161  wxBitmap bitmap( image );
162 
163  return image;
164 }
165 
166 
168 {
169  COMMON_SETTINGS* settings = Pgm().GetCommonSettings();
170  wxString oldTheme = m_theme;
171 
172  if( settings )
173  {
174  switch( settings->m_Appearance.icon_theme )
175  {
176  case ICON_THEME::LIGHT: m_theme = wxT( "light" ); break;
177  case ICON_THEME::DARK: m_theme = wxT( "dark" ); break;
178  case ICON_THEME::AUTO:
179  m_theme = KIPLATFORM::UI::IsDarkTheme() ? wxT( "dark" ) : wxT( "light" );
180  break;
181  }
182  }
183  else
184  {
185  m_theme = wxT( "light" );
186  }
187 
188  if( !oldTheme.IsSameAs( m_theme ) )
189  m_bitmapNameCache.clear();
190 }
191 
192 
193 const wxString& BITMAP_STORE::bitmapName( BITMAPS aBitmapId, int aHeight )
194 {
195  std::pair<BITMAPS, int> key = std::make_pair( aBitmapId, aHeight );
196 
197  if( !m_bitmapNameCache.count( key ) )
198  m_bitmapNameCache[key] = computeBitmapName( aBitmapId, aHeight );
199 
200  return m_bitmapNameCache.at( key );
201 }
202 
203 
204 wxString BITMAP_STORE::computeBitmapName( BITMAPS aBitmapId, int aHeight )
205 {
206  if( !m_bitmapInfoCache.count( aBitmapId ) )
207  {
208  wxLogTrace( traceBitmaps, "No bitmap info available for %d", aBitmapId );
209  return wxEmptyString;
210  }
211 
212  wxString fn;
213 
214  for( const BITMAP_INFO& info : m_bitmapInfoCache.at( aBitmapId ) )
215  {
216  if( info.theme != m_theme )
217  continue;
218 
219  if( aHeight < 0 || info.height == aHeight )
220  {
221  fn = info.filename;
222  break;
223  }
224  }
225 
226  if( fn.IsEmpty() )
227  {
228  wxLogTrace( traceBitmaps, "No bitmap found matching ID %d, height %d, theme %s",
229  aBitmapId, aHeight, m_theme );
230  return m_bitmapInfoCache.at( aBitmapId ).begin()->filename;
231  }
232 
233  return fn;
234 }
235 
236 
238 {
239  for( const BITMAP_INFO& entry : g_BitmapInfo )
240  m_bitmapInfoCache[entry.id].emplace_back( entry );
241 }
void buildBitmapInfoCache()
wxBitmap GetBitmapScaled(BITMAPS aBitmapId, int aScaleFactor, int aHeight=-1)
Retrieves a bitmap from the given bitmap id, scaled to a given factor.
static const unsigned char s_imageNotFound[]
A question-mark icon shown when we can't find a given bitmap in the archive.
bool IsDarkTheme()
Determine if the desktop interface is currently using a dark theme or a light theme.
Definition: gtk/ui.cpp:31
std::unordered_map< std::pair< BITMAPS, int >, wxString > m_bitmapNameCache
Definition: bitmap_store.h:93
APPEARANCE m_Appearance
const std::vector< BITMAP_INFO > g_BitmapInfo
Definition: bitmap_info.h:42
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
static wxString GetStockDataPath(bool aRespectRunFromBuildDir=true)
Gets the stock (install) data path, which is the base path for things like scripting,...
Definition: paths.cpp:150
wxString computeBitmapName(BITMAPS aBitmapId, int aHeight=-1)
wxString m_theme
Definition: bitmap_store.h:97
std::unordered_map< BITMAPS, std::vector< BITMAP_INFO > > m_bitmapInfoCache
Definition: bitmap_store.h:95
wxImage getImage(BITMAPS aBitmapId, int aHeight=-1)
static const unsigned char s_dummyItem[]
Icon used for EDA_ITEMs that don't have a custom icon configured.
This file is auto-generated by CMake when MAINTAIN_PNGS is on.
Definition: bitmap_info.h:33
void ThemeChanged()
Notifies the store that the icon theme has been changed by the user, so caches must be invalidated.
static const wxString traceBitmaps
see class PGM_BASE
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:32
wxBitmap GetBitmap(BITMAPS aBitmapId, int aHeight=-1)
Retrieves a bitmap from the given bitmap id.
std::unique_ptr< ASSET_ARCHIVE > m_archive
Definition: bitmap_store.h:91
const wxString & bitmapName(BITMAPS aBitmapId, int aHeight=-1)
static const wxString IMAGE_ARCHIVE