LibreOffice: salhelper/linkhelper.hxx Source File

LibreOffice LibreOffice 7.1 SDK C/C++ API Reference

linkhelper.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 */
9
10#ifndef INCLUDED_SALHELPER_LINKHELPER_HXX
11#define INCLUDED_SALHELPER_LINKHELPER_HXX
12
13#include "rtl/ustring.hxx"
14#include "osl/file.hxx"
15
16namespace salhelper
17{
18 class SAL_WARN_UNUSED LinkResolver
19 {
20 public:
21 osl::FileStatus m_aStatus;
22
23 LinkResolver(sal_uInt32 nMask)
24 : m_aStatus(nMask |
25 osl_FileStatus_Mask_FileURL |
26 osl_FileStatus_Mask_Type |
27 osl_FileStatus_Mask_LinkTargetURL)
28 {
29 }
30
38 osl::FileBase::RC fetchFileStatus(const rtl::OUString &rURL,
39 int nDepth = 128)
40 {
41 //In an ideal world this wouldn't be inline, but I want to use this
42 //in jvmfwk hence salhelper, but salhelper is .map controlled and
43 //getting all the mangled names right is a misery, moving it over
44 //to visibility markup would drop per-symbol versioning
45 osl::FileBase::RC eReturn;
46
47 osl::DirectoryItem item;
48 rtl::OUString sURL(rURL);
49 while ((eReturn = osl::DirectoryItem::get(sURL, item))
50 == osl::File::E_None)
51 {
52 if (--nDepth == 0)
53 {
54 eReturn = osl::FileBase::E_MULTIHOP;
55 break;
56 }
57 eReturn = item.getFileStatus(m_aStatus);
58 if (eReturn != osl::File::E_None)
59 break;
60 if (m_aStatus.getFileType() != osl::FileStatus::Link)
61 {
62 eReturn = osl::FileBase::E_None;
63 break;
64 }
65 sURL = m_aStatus.getLinkTargetURL();
66 }
67
68 return eReturn;
69 }
70 };
71}
72
73#endif
74
75/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SAL_WARN_UNUSED
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:558
ustring.hxx
file.hxx
osl_FileStatus_Mask_Type
#define osl_FileStatus_Mask_Type
Definition: file.h:360
osl_FileStatus_Mask_FileURL
#define osl_FileStatus_Mask_FileURL
Definition: file.h:367
osl_FileStatus_Mask_LinkTargetURL
#define osl_FileStatus_Mask_LinkTargetURL
Definition: file.h:368
salhelper
Definition: condition.hxx:31
osl::FileBase::RC
RC
Definition: file.hxx:53
osl::FileBase::E_MULTIHOP
@ E_MULTIHOP
remote resource is not directly available
Definition: file.hxx:95
osl::FileBase::E_None
@ E_None
on success
Definition: file.hxx:54
osl::FileStatus
The FileStatus class.
Definition: file.hxx:635
osl::FileStatus::Link
@ Link
Definition: file.hxx:657
osl::FileStatus::getLinkTargetURL
::rtl::OUString getLinkTargetURL() const
Get the link target URL.
Definition: file.hxx:868
osl::FileStatus::getFileType
Type getFileType() const
Get the file type.
Definition: file.hxx:705
osl::DirectoryItem
The directory item class object provides access to file status information.
Definition: file.hxx:1429
osl::DirectoryItem::get
static RC get(const ::rtl::OUString &ustrFileURL, DirectoryItem &rItem)
Retrieve a single directory item.
Definition: file.hxx:1521
osl::DirectoryItem::getFileStatus
RC getFileStatus(FileStatus &rStatus)
Retrieve information about a single file or directory.
Definition: file.hxx:1563
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling.
Definition: ustring.hxx:161
salhelper::LinkResolver
Definition: linkhelper.hxx:19
salhelper::LinkResolver::LinkResolver
LinkResolver(sal_uInt32 nMask)
Definition: linkhelper.hxx:23
salhelper::LinkResolver::fetchFileStatus
osl::FileBase::RC fetchFileStatus(const rtl::OUString &rURL, int nDepth=128)
Resolve a file url if it's a symbolic link, to a maximum depth of nDepth and fill in m_aStatus with t...
Definition: linkhelper.hxx:38
salhelper::LinkResolver::m_aStatus
osl::FileStatus m_aStatus
Definition: linkhelper.hxx:21