blob: d5de3f2a048dbf38da027f2ad754d5190e9d846e [file] [log] [blame]
// Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
/// Make it possible to load resources from the dartdoc code repository.
library dartdoc.resource_loader;
import 'dart:convert' show utf8;
import 'dart:isolate' show Isolate;
import 'package:analyzer/file_system/file_system.dart';
import 'package:meta/meta.dart';
extension ResourceLoader on ResourceProvider {
/// Loads a `package:` resource as a String.
Future<String> loadResourceAsString(String path) async {
var bytes = await loadResourceAsBytes(path);
return utf8.decode(bytes);
/// Loads a `package:` resource as an [List<int>].
Future<List<int>> loadResourceAsBytes(String path) async {
if (!path.startsWith('package:')) {
throw ArgumentError('path must begin with package:');
return (await getResourceFile(path)).readAsBytesSync();
Future<File> getResourceFile(String path) async {
var uri = await resolveResourceUri(Uri.parse(path));
return getFile(uri.toFilePath());
Future<Folder> getResourceFolder(String path) async {
var uri = await resolveResourceUri(Uri.parse(path));
return getFolder(uri.toFilePath());
/// Resolves a non-relative, non-package URI.
Future<Uri> resolveResourceUri(Uri uri) async {
if (uri.scheme == 'package') {
var resolvedUri = await Isolate.resolvePackageUri(uri);
if (resolvedUri == null) {
throw ArgumentError.value(uri, 'uri', 'Unknown package');
return resolvedUri;
} else {
return Uri.base.resolveUri(uri);