5#include <QtCore/qglobal.h>
7#include <AppKit/AppKit.h>
13#include <QtCore/qbuffer.h>
14#include <QtCore/qdebug.h>
15#include <QtCore/qstringlist.h>
16#include <QtCore/qvarlengtharray.h>
17#include <QtCore/qabstracteventdispatcher.h>
18#include <QtCore/qdir.h>
19#include <QtCore/qregularexpression.h>
20#include <QtCore/qpointer.h>
21#include <QtCore/private/qcore_mac_p.h>
23#include <QtGui/qguiapplication.h>
24#include <QtGui/private/qguiapplication_p.h>
26#include <qpa/qplatformtheme.h>
27#include <qpa/qplatformnativeinterface.h>
29#include <UniformTypeIdentifiers/UniformTypeIdentifiers.h>
33using namespace Qt::StringLiterals;
38 return QPlatformTheme::removeMnemonics(s).trimmed().toNSString();
44 if ([panel isKindOfClass:NSOpenPanel.
class])
45 return static_cast<NSOpenPanel*>(panel);
52@implementation QNSOpenSavePanelDelegate {
55 NSView *m_accessoryView;
56 NSPopUpButton *m_popupButton;
57 NSTextField *m_textField;
58 QPointer<QCocoaFileDialogHelper> m_helper;
60 SharedPointerFileDialogOptions m_options;
61 QString m_currentSelection;
62 QStringList m_nameFilterDropDownList;
63 QStringList m_selectedNameFilter;
66- (instancetype)initWithAcceptMode:(
const QString &)selectFile
67 options:(SharedPointerFileDialogOptions)options
68 helper:(QCocoaFileDialogHelper *)helper
70 if ((self = [super init])) {
73 if (m_options->acceptMode() == QFileDialogOptions::AcceptOpen)
74 m_panel = [[NSOpenPanel openPanel] retain];
76 m_panel = [[NSSavePanel savePanel] retain];
78 m_panel.canSelectHiddenExtension = YES;
79 m_panel.level = NSModalPanelWindowLevel;
83 m_nameFilterDropDownList = m_options->nameFilters();
84 QString selectedVisualNameFilter = m_options->initiallySelectedNameFilter();
85 m_selectedNameFilter = [self findStrippedFilterWithVisualFilterName:selectedVisualNameFilter];
87 m_panel.extensionHidden = [&]{
88 for (
const auto &nameFilter : m_nameFilterDropDownList) {
89 const auto extensions = QPlatformFileDialogHelper::cleanFilterList(nameFilter);
90 for (
const auto &extension : extensions) {
96 if (extension ==
"*"_L1 || extension ==
"*.*"_L1)
110 if (extension.count(
'.') > 1)
117 const QFileInfo sel(selectFile);
118 if (sel.isDir() && !sel.isBundle()){
119 m_panel.directoryURL = [NSURL fileURLWithPath:sel.absoluteFilePath().toNSString()];
120 m_currentSelection.clear();
122 m_panel.directoryURL = [NSURL fileURLWithPath:sel.absolutePath().toNSString()];
123 m_currentSelection = sel.absoluteFilePath();
126 [self createPopUpButton:selectedVisualNameFilter hideDetails:options->testOption(QFileDialogOptions::HideNameFilterDetails)];
127 [self createTextField];
128 [self createAccessory];
130 m_panel.accessoryView = m_nameFilterDropDownList.size() > 1 ? m_accessoryView : nil;
134 m_panel.delegate = self;
136 if (
auto *openPanel = openpanel_cast(m_panel))
137 openPanel.accessoryViewDisclosed = YES;
139 [self updateProperties];
146 [m_panel orderOut:m_panel];
147 m_panel.accessoryView = nil;
148 [m_popupButton release];
149 [m_textField release];
150 [m_accessoryView release];
151 m_panel.delegate = nil;
156- (
bool)showPanel:(Qt::WindowModality) windowModality withParent:(QWindow *)parent
158 const QFileInfo info(m_currentSelection);
159 NSString *filepath = info.filePath().toNSString();
160 NSURL *url = [NSURL fileURLWithPath:filepath isDirectory:info.isDir()];
161 bool selectable = (m_options->acceptMode() == QFileDialogOptions::AcceptSave)
162 || [self panel:m_panel shouldEnableURL:url];
164 if (!openpanel_cast(m_panel))
165 m_panel.nameFieldStringValue = selectable ? info.fileName().toNSString() : @
"";
167 [self updateProperties];
169 auto completionHandler = ^(NSInteger result) {
171 m_helper->panelClosed(result);
174 if (windowModality == Qt::WindowModal && parent) {
175 NSView *view =
reinterpret_cast<NSView*>(parent->winId());
176 [m_panel beginSheetModalForWindow:view.window completionHandler:completionHandler];
177 }
else if (windowModality == Qt::ApplicationModal) {
180 [m_panel beginWithCompletionHandler:completionHandler];
186-(
void)runApplicationModalPanel
195 QMacAutoReleasePool pool;
200 qApp->processEvents(QEventLoop::ExcludeUserInputEvents | QEventLoop::ExcludeSocketNotifiers);
203 QCocoaEventDispatcher::clearCurrentThreadCocoaEventDispatcherInterruptFlag();
205 auto result = [m_panel runModal];
206 m_helper->panelClosed(result);
210 QCoreApplication::eventDispatcher()->wakeUp();
215 m_currentSelection = QString::fromNSString(m_panel.URL.path).normalized(QString::NormalizationForm_C);
218 [NSApp endSheet:m_panel];
219 else if (NSApp.modalWindow == m_panel)
225- (BOOL)panel:(id)sender shouldEnableURL:(NSURL *)url
229 NSString *filename = url.path;
230 if (!filename.length)
233 const QFileInfo fileInfo(QString::fromNSString(filename));
237 if (fileInfo.isDir()) {
243 bool treatBundlesAsFiles = !m_panel.treatsFilePackagesAsDirectories;
244 if (!(treatBundlesAsFiles && [NSWorkspace.sharedWorkspace isFilePackageAtPath:filename]))
248 if (![self fileInfoMatchesCurrentNameFilter:fileInfo])
251 QDir::Filters filter = m_options->filter();
252 if ((!(filter & (QDir::Dirs | QDir::AllDirs)) && fileInfo.isDir())
253 || (!(filter & QDir::Files) && (fileInfo.isFile() && !fileInfo.isSymLink()))
254 || ((filter & QDir::NoSymLinks) && fileInfo.isSymLink()))
257 bool filterPermissions = ((filter & QDir::PermissionMask)
258 && (filter & QDir::PermissionMask) != QDir::PermissionMask);
259 if (filterPermissions) {
260 if ((!(filter & QDir::Readable) && fileInfo.isReadable())
261 || (!(filter & QDir::Writable) && fileInfo.isWritable())
262 || (!(filter & QDir::Executable) && fileInfo.isExecutable()))
276- (BOOL)panel:(id)sender validateURL:(NSURL *)url error:(NSError *
_Nullable *)outError
278 Q_ASSERT(sender == m_panel);
280 if (![m_panel.allowedContentTypes count] && !m_selectedNameFilter.isEmpty()) {
285 QFileInfo fileInfo(QString::fromNSString(url.path).normalized(QString::NormalizationForm_C));
287 if ([self fileInfoMatchesCurrentNameFilter:fileInfo])
290 if (fileInfo.suffix().isEmpty()) {
295 fileInfo = [self applyDefaultSuffixFromCurrentNameFilter:fileInfo];
297 if (!fileInfo.exists() || m_options->testOption(QFileDialogOptions::DontConfirmOverwrite))
300 QMacAutoReleasePool pool;
301 auto *alert = [[NSAlert
new] autorelease];
302 alert.alertStyle = NSAlertStyleCritical;
304 alert.messageText = [NSString stringWithFormat:qt_mac_AppKitString(@
"SavePanel",
305 @
"\\U201c%@\\U201d already exists. Do you want to replace it?"),
306 fileInfo.fileName().toNSString()];
307 alert.informativeText = [NSString stringWithFormat:qt_mac_AppKitString(@
"SavePanel",
308 @
"A file or folder with the same name already exists in the folder %@. "
309 "Replacing it will overwrite its current contents."),
310 fileInfo.absoluteDir().dirName().toNSString()];
312 auto *replaceButton = [alert addButtonWithTitle:qt_mac_AppKitString(@
"SavePanel", @
"Replace")];
313 replaceButton.hasDestructiveAction = YES;
314 replaceButton.tag = 1337;
315 [alert addButtonWithTitle:qt_mac_AppKitString(@
"Common", @
"Cancel")];
317 [alert beginSheetModalForWindow:m_panel
318 completionHandler:^(NSModalResponse returnCode) {
319 [NSApp stopModalWithCode:returnCode];
321 return [NSApp runModalForWindow:alert.window] == replaceButton.tag;
323 QFileInfo firstFilter(m_selectedNameFilter.first());
324 auto *domain = qGuiApp->organizationDomain().toNSString();
325 *outError = [NSError errorWithDomain:domain code:0 userInfo:@{
326 NSLocalizedDescriptionKey:[NSString stringWithFormat:qt_mac_AppKitString(@
"SavePanel",
327 @
"You cannot save this document with extension \\U201c.%1$@\\U201d at the end "
328 "of the name. The required extension is \\U201c.%2$@\\U201d."),
329 fileInfo.completeSuffix().toNSString(), firstFilter.completeSuffix().toNSString()]
338- (
QFileInfo)applyDefaultSuffixFromCurrentNameFilter:(
const QFileInfo &)fileInfo
340 QFileInfo filterInfo(m_selectedNameFilter.first());
341 return QFileInfo(fileInfo.absolutePath(),
342 fileInfo.baseName() +
'.' + filterInfo.completeSuffix());
345- (
bool)fileInfoMatchesCurrentNameFilter:(
const QFileInfo &)fileInfo
348 if (m_selectedNameFilter.isEmpty())
352 for (
const auto &filter : m_selectedNameFilter) {
353 if (QDir::match(filter, fileInfo.fileName()))
360- (
void)setNameFilters:(
const QStringList &)filters hideDetails:(BOOL)hideDetails
362 [m_popupButton removeAllItems];
363 m_nameFilterDropDownList = filters;
364 if (filters.size() > 0){
365 for (
int i = 0; i < filters.size(); ++i) {
366 const QString filter = hideDetails ? [self removeExtensions:filters.at(i)] : filters.at(i);
367 [m_popupButton.menu addItemWithTitle:filter.toNSString() action:nil keyEquivalent:@
""];
369 [m_popupButton selectItemAtIndex:0];
370 m_panel.accessoryView = m_accessoryView;
372 m_panel.accessoryView = nil;
375 [self filterChanged:self];
378- (
void)filterChanged:(id)sender
384 const QString selection = m_nameFilterDropDownList.value([m_popupButton indexOfSelectedItem]);
385 m_selectedNameFilter = [self findStrippedFilterWithVisualFilterName:selection];
386 [m_panel validateVisibleColumns];
387 [self updateProperties];
389 const QStringList filters = m_options->nameFilters();
390 const int menuIndex = m_popupButton.indexOfSelectedItem;
391 emit m_helper->filterSelected(menuIndex >= 0 && menuIndex < filters.size() ? filters.at(menuIndex) : QString());
394- (QList<QUrl>)selectedFiles
396 if (
auto *openPanel = openpanel_cast(m_panel)) {
398 for (NSURL *url in openPanel.URLs) {
399 QString path = QString::fromNSString(url.path).normalized(QString::NormalizationForm_C);
400 result << QUrl::fromLocalFile(path);
404 QString filename = QString::fromNSString(m_panel.URL.path).normalized(QString::NormalizationForm_C);
405 QFileInfo fileInfo(filename);
407 if (fileInfo.suffix().isEmpty() && ![self fileInfoMatchesCurrentNameFilter:fileInfo]) {
411 fileInfo = [self applyDefaultSuffixFromCurrentNameFilter:fileInfo];
416 const QString defaultSuffix = m_options->defaultSuffix();
417 if (fileInfo.suffix().isEmpty() && !defaultSuffix.isEmpty()) {
418 fileInfo.setFile(fileInfo.absolutePath(),
419 fileInfo.baseName() +
'.' + defaultSuffix);
422 return { QUrl::fromLocalFile(fileInfo.filePath()) };
426- (
void)updateProperties
428 const QFileDialogOptions::FileMode fileMode = m_options->fileMode();
429 bool chooseFilesOnly = fileMode == QFileDialogOptions::ExistingFile
430 || fileMode == QFileDialogOptions::ExistingFiles;
431 bool chooseDirsOnly = fileMode == QFileDialogOptions::Directory
432 || fileMode == QFileDialogOptions::DirectoryOnly
433 || m_options->testOption(QFileDialogOptions::ShowDirsOnly);
435 m_panel.title = m_options->windowTitle().toNSString();
436 m_panel.canCreateDirectories = !(m_options->testOption(QFileDialogOptions::ReadOnly));
438 if (m_options->isLabelExplicitlySet(QFileDialogOptions::Accept))
439 m_panel.prompt = strippedText(m_options->labelText(QFileDialogOptions::Accept));
440 if (m_options->isLabelExplicitlySet(QFileDialogOptions::FileName))
441 m_panel.nameFieldLabel = strippedText(m_options->labelText(QFileDialogOptions::FileName));
443 if (
auto *openPanel = openpanel_cast(m_panel)) {
444 openPanel.canChooseFiles = !chooseDirsOnly;
445 openPanel.canChooseDirectories = !chooseFilesOnly;
446 openPanel.allowsMultipleSelection = (fileMode == QFileDialogOptions::ExistingFiles);
447 openPanel.resolvesAliases = !(m_options->testOption(QFileDialogOptions::DontResolveSymlinks));
450 m_popupButton.hidden = chooseDirsOnly;
452 m_panel.allowedContentTypes = [self computeAllowedContentTypes];
462 const bool nameFieldHasExtension = m_panel.nameFieldStringValue.pathExtension.length > 0;
463 if (![m_panel.allowedContentTypes count] && !nameFieldHasExtension && !openpanel_cast(m_panel)) {
464 if (!UTTypeDirectory.preferredFilenameExtension) {
465 m_panel.allowedContentTypes = @[ UTTypeDirectory ];
466 m_panel.allowedContentTypes = @[];
468 qWarning() <<
"UTTypeDirectory unexpectedly reported an extension";
472 m_panel.showsHiddenFiles = m_options->filter().testFlag(QDir::Hidden);
475 [m_panel validateVisibleColumns];
478- (
void)panelSelectionDidChange:(id)sender
490 if (!openpanel_cast(m_panel))
493 if (m_panel.visible) {
494 const QString selection = QString::fromNSString(m_panel.URL.path).normalized(QString::NormalizationForm_C);
495 if (selection != m_currentSelection) {
496 m_currentSelection = selection;
497 emit m_helper->currentChanged(QUrl::fromLocalFile(selection));
502- (
void)panel:(id)sender directoryDidChange:(NSString *)path
509 m_helper->panelDirectoryDidChange(path);
513
514
515
516
517
518
519
520
521- (NSArray<UTType*>*)computeAllowedContentTypes
523 if (m_options->acceptMode() != QFileDialogOptions::AcceptSave)
526 auto *types = [[NSMutableArray<UTType*>
new] autorelease];
527 for (
const QString &filter : std::as_const(m_selectedNameFilter)) {
528 if (!filter.startsWith(
"*."_L1))
531 if (filter.contains(u'?'))
534 if (filter.count(u'*') != 1)
537 auto extensions = filter.split(
'.', Qt::SkipEmptyParts);
538 if (extensions.count() > 2)
541 auto *utType = [UTType typeWithFilenameExtension:extensions.last().toNSString()];
542 [types addObject:utType];
548- (
QString)removeExtensions:(
const QString &)filter
550 QRegularExpression regExp(QString::fromLatin1(QPlatformFileDialogHelper::filterRegExp));
551 QRegularExpressionMatch match = regExp.match(filter);
552 if (match.hasMatch())
553 return match.captured(1).trimmed();
557- (
void)createTextField
559 NSRect textRect = { { 0.0, 3.0 }, { 100.0, 25.0 } };
560 m_textField = [[NSTextField alloc] initWithFrame:textRect];
561 m_textField.cell.font = [NSFont systemFontOfSize:[NSFont systemFontSizeForControlSize:NSControlSizeRegular]];
562 m_textField.alignment = NSTextAlignmentRight;
563 m_textField.editable =
false;
564 m_textField.selectable =
false;
565 m_textField.bordered =
false;
566 m_textField.drawsBackground =
false;
567 if (m_options->isLabelExplicitlySet(QFileDialogOptions::FileType))
568 m_textField.stringValue = strippedText(m_options->labelText(QFileDialogOptions::FileType));
571- (
void)createPopUpButton:(
const QString &)selectedFilter hideDetails:(BOOL)hideDetails
573 NSRect popUpRect = { { 100.0, 5.0 }, { 250.0, 25.0 } };
574 m_popupButton = [[NSPopUpButton alloc] initWithFrame:popUpRect pullsDown:NO];
575 m_popupButton.target = self;
576 m_popupButton.action = @selector(filterChanged:);
578 if (!m_nameFilterDropDownList.isEmpty()) {
579 int filterToUse = -1;
580 for (
int i = 0; i < m_nameFilterDropDownList.size(); ++i) {
581 const QString currentFilter = m_nameFilterDropDownList.at(i);
582 if (selectedFilter == currentFilter ||
583 (filterToUse == -1 && currentFilter.startsWith(selectedFilter)))
585 QString filter = hideDetails ? [self removeExtensions:currentFilter] : currentFilter;
586 [m_popupButton.menu addItemWithTitle:filter.toNSString() action:nil keyEquivalent:@
""];
588 if (filterToUse != -1)
589 [m_popupButton selectItemAtIndex:filterToUse];
593- (
QStringList) findStrippedFilterWithVisualFilterName:(QString)name
595 for (
const QString ¤tFilter : std::as_const(m_nameFilterDropDownList)) {
596 if (currentFilter.startsWith(name))
597 return QPlatformFileDialogHelper::cleanFilterList(currentFilter);
599 return QStringList();
602- (
void)createAccessory
604 NSRect accessoryRect = { { 0.0, 0.0 }, { 450.0, 33.0 } };
605 m_accessoryView = [[NSView alloc] initWithFrame:accessoryRect];
606 [m_accessoryView addSubview:m_textField];
607 [m_accessoryView addSubview:m_popupButton];
614QCocoaFileDialogHelper::QCocoaFileDialogHelper()
623 QMacAutoReleasePool pool;
624 [m_delegate release];
630 if (result == NSModalResponseOK)
638 m_directory = directory;
641 m_delegate->m_panel.directoryURL = [NSURL fileURLWithPath:directory.toLocalFile().toNSString()];
651 if (!path || [path isEqual:NSNull.null] || !path.length)
654 const auto oldDirectory = m_directory;
655 m_directory = QUrl::fromLocalFile(
656 QString::fromNSString(path).normalized(QString::NormalizationForm_C));
658 if (m_directory != oldDirectory) {
660 emit directoryEntered(m_directory);
666 QString filePath = filename.toLocalFile();
667 if (QDir::isRelativePath(filePath))
668 filePath = QFileInfo(directory().toLocalFile(), filePath).filePath();
672 setDirectory(QFileInfo(filePath).absolutePath());
678 return [m_delegate selectedFiles];
679 return QList<QUrl>();
687 [m_delegate updateProperties];
694 const int index = options()->nameFilters().indexOf(filter);
697 options()->setInitiallySelectedNameFilter(filter);
700 [m_delegate->m_popupButton selectItemAtIndex:index];
701 [m_delegate filterChanged:nil];
708 return options()->initiallySelectedNameFilter();
709 int index = [m_delegate->m_popupButton indexOfSelectedItem];
710 if (index >= options()->nameFilters().count())
712 return index != -1 ? options()->nameFilters().at(index) : QString();
720 [m_delegate closePanel];
728 if (windowFlags & Qt::WindowStaysOnTopHint) {
736 createNSOpenSavePanelDelegate();
738 return [m_delegate showPanel:windowModality withParent:parent];
743 QMacAutoReleasePool pool;
746 const QList<QUrl> selectedFiles = opts->initiallySelectedFiles();
747 const QUrl directory = m_directory.isEmpty() ? opts->initialDirectory() : m_directory;
748 const bool selectDir = selectedFiles.isEmpty();
749 QString selection(selectDir ? directory.toLocalFile() : selectedFiles.front().toLocalFile());
750 QNSOpenSavePanelDelegate *delegate = [[QNSOpenSavePanelDelegate alloc]
756 [
static_cast<QNSOpenSavePanelDelegate *>(m_delegate) release];
757 m_delegate = delegate;
762 Q_ASSERT(m_delegate);
764 if (m_delegate->m_panel.visible) {
766 QEventLoop eventLoop;
767 m_eventLoop = &eventLoop;
768 eventLoop.exec(QEventLoop::DialogExec);
769 m_eventLoop =
nullptr;
772 [m_delegate runApplicationModalPanel];
QList< QUrl > selectedFiles() const override
bool defaultNameFilterDisables() const override
void setFilter() override
QString selectedNameFilter() const override
void panelDirectoryDidChange(NSString *path)
QUrl directory() const override
void setDirectory(const QUrl &directory) override
virtual ~QCocoaFileDialogHelper()
bool show(Qt::WindowFlags windowFlags, Qt::WindowModality windowModality, QWindow *parent) override
void selectNameFilter(const QString &filter) override
void selectFile(const QUrl &filename) override
void panelClosed(NSInteger result)
QSharedPointer< QFileDialogOptions > SharedPointerFileDialogOptions
static NSString * strippedText(QString s)
static NSOpenPanel * openpanel_cast(NSSavePanel *panel)
QList< QString > QStringList
Constructs a string list that contains the given string, str.