Skip to content

Commit

Permalink
Add comments
Browse files Browse the repository at this point in the history
  • Loading branch information
PlugFox committed Jan 19, 2024
1 parent 4657f85 commit ac2e5a5
Show file tree
Hide file tree
Showing 15 changed files with 29 additions and 33 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ extension on StringBuffer {
.toString();
}

/// {@nodoc}
@internal
base mixin ConsoleLogFormatterMixin on MessageFormattingPipeline {
@override
Expand Down
2 changes: 0 additions & 2 deletions lib/src/environment_specific/log_delegate.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@ import 'package:meta/meta.dart';

import '../../l.dart';

/// {@nodoc}
@internal
// ignore: one_member_abstracts
abstract interface class LogDelegate {
/// {@nodoc}
void log(LogMessage event);
}
7 changes: 2 additions & 5 deletions lib/src/environment_specific/log_delegate_js.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,17 @@ import 'log_delegate.dart';
import 'message_formatting_pipeline.dart';
import 'message_log_formatting_mixin.dart';

/// {@nodoc}
/// Environment-specific implementation of [LogDelegate]
@internal
LogDelegate createEnvironmentLogDelegate() =>
LogDelegate$JS(html.window.console);

/// {@nodoc}
@internal
final class LogDelegate$JS implements LogDelegate {
/// {@nodoc}
LogDelegate$JS(this.console);

final MessageFormattingPipeline _formatter = MessageFormattingPipelineWeb();

/// {@nodoc}
@protected
final html.Console console;

Expand All @@ -44,7 +41,7 @@ final class LogDelegate$JS implements LogDelegate {
}
}

/// {@nodoc}
/// Environment-specific implementation of [MessageFormattingPipeline]
@internal
final class MessageFormattingPipelineWeb = MessageFormattingPipeline
with MessageLogFormatterMixin;
6 changes: 2 additions & 4 deletions lib/src/environment_specific/log_delegate_stub.dart
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@ import 'log_delegate.dart';
import 'message_formatting_pipeline.dart';
import 'message_log_formatting_mixin.dart';

/// {@nodoc}
/// Environment-specific implementation of [LogDelegate]
@internal
LogDelegate createEnvironmentLogDelegate() => LogDelegate$Stub();

/// {@nodoc}
@internal
final class LogDelegate$Stub implements LogDelegate {
/// {@nodoc}
LogDelegate$Stub();

final MessageFormattingPipeline _formatter = MessageFormattingPipelineStub();
Expand All @@ -30,7 +28,7 @@ final class LogDelegate$Stub implements LogDelegate {
void _printToConsole(String line) => Zone.root.print(line);
}

/// {@nodoc}
/// Environment-specific implementation of [MessageFormattingPipeline]
@internal
final class MessageFormattingPipelineStub = MessageFormattingPipeline
with ConsoleLogFormatterMixin, MessageLogFormatterMixin;
7 changes: 2 additions & 5 deletions lib/src/environment_specific/log_delegate_vm.dart
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,17 @@ import 'log_delegate_stub.dart';
import 'message_formatting_pipeline.dart';
import 'message_log_formatting_mixin.dart';

/// {@nodoc}
/// Environment-specific implementation of [LogDelegate]
@internal
LogDelegate createEnvironmentLogDelegate() =>
io.stdout.hasTerminal ? LogDelegate$VM(io.stdout) : LogDelegate$Stub();

/// {@nodoc}
@internal
final class LogDelegate$VM implements LogDelegate {
/// {@nodoc}
LogDelegate$VM(this.console);

final MessageFormattingPipeline _formatter = MessageFormattingPipelineIO();

/// {@nodoc}
@protected
final io.Stdout console;

Expand All @@ -34,7 +31,7 @@ final class LogDelegate$VM implements LogDelegate {
}
}

/// {@nodoc}
/// Environment-specific implementation of [MessageFormattingPipeline]
@internal
final class MessageFormattingPipelineIO = MessageFormattingPipeline
with ConsoleLogFormatterMixin, MessageLogFormatterMixin;
2 changes: 0 additions & 2 deletions lib/src/environment_specific/message_formatting_pipeline.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@ import 'package:meta/meta.dart';

import '../log_message.dart';

/// {@nodoc}
@internal
abstract base class MessageFormattingPipeline {
/// {@nodoc}
@internal
String? format(LogMessage event) => event.message.toString();
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import '../log_message.dart';
import '../log_options.dart';
import 'message_formatting_pipeline.dart';

/// {@nodoc}
@internal
base mixin MessageLogFormatterMixin on MessageFormattingPipeline {
@override
Expand Down
4 changes: 0 additions & 4 deletions lib/src/inner_logger.dart
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,14 @@ import 'inner_zoned_mixin.dart';
import 'log_message.dart';
import 'logger.dart';

/// {@nodoc}
@internal
abstract base class InnerLogger extends Stream<LogMessage> implements L {
/// Notify subscribers
/// {@nodoc}
@protected
@visibleForOverriding
void notifyListeners(LogMessage event);
}

/// {@nodoc}
@internal
final class InnerLoggerImpl extends InnerLogger
with
Expand All @@ -32,7 +29,6 @@ final class InnerLoggerImpl extends InnerLogger
InnerLoggerShortcutsMixin,
InnerZonedMixin {
//region InnerLoggerImpl singleton factory
/// {@nodoc}
factory InnerLoggerImpl() => _internalSingleton;
InnerLoggerImpl._internal();
static final InnerLoggerImpl _internalSingleton = InnerLoggerImpl._internal();
Expand Down
5 changes: 4 additions & 1 deletion lib/src/inner_logger_log_mixin.dart
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import 'package:meta/meta.dart';

import 'environment_specific/log_delegate.dart';
import 'environment_specific/log_delegate_stub.dart'
// ignore: uri_does_not_exist
Expand All @@ -14,7 +16,8 @@ const bool _kIsDebug = !bool.fromEnvironment(
defaultValue: true,
);

/// {@nodoc}
/// Log mixin for [InnerLogger]
@internal
base mixin InnerLoggerLogMixin on InnerLogger {
final LogDelegate _delegate = createEnvironmentLogDelegate();

Expand Down
5 changes: 4 additions & 1 deletion lib/src/inner_logger_methods_mixin.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
import 'package:meta/meta.dart';

import 'inner_logger.dart';
import 'log_level.dart';
import 'log_message.dart';
import 'logger.dart';

/// {@nodoc}
/// Methods for logging
@internal
base mixin InnerLoggerMethodsMixin on InnerLogger {
@override
void s(
Expand Down
5 changes: 4 additions & 1 deletion lib/src/inner_logger_operators_mixin.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import 'package:meta/meta.dart';

import 'inner_logger.dart';

/// {@nodoc}
/// Operators for logging
@internal
base mixin InnerLoggerOperatorsMixin on InnerLogger {
@override
void operator <(Object info) => super.i(info);
Expand Down
5 changes: 4 additions & 1 deletion lib/src/inner_logger_shortcuts_mixin.dart
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import 'package:meta/meta.dart';

import 'inner_logger.dart';
import 'logger.dart';

/// {@nodoc}
/// Shortcuts for logging
@internal
base mixin InnerLoggerShortcutsMixin on InnerLogger {
@override
void v1(Object message, [LogMessageContext? context]) =>
Expand Down
5 changes: 4 additions & 1 deletion lib/src/inner_logger_subscription_mixin.dart
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
import 'dart:async';

import 'package:meta/meta.dart';

import 'inner_logger.dart';
import 'log_message.dart';

/// {@nodoc}
/// Subscription for logging
@internal
base mixin InnerLoggerSubscriptionMixin on InnerLogger {
/// Whether there is a subscriber on the [Stream].
bool get hasListener => _controller.hasListener;
Expand Down
5 changes: 3 additions & 2 deletions lib/src/inner_zoned_mixin.dart
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ import 'log_options.dart';

const Symbol _kOptionsKey = #l.logOptions;

/// {@nodoc}
/// Receive [LogOptions] from [Zone]
@internal
LogOptions? getCurrentLogOptions() => switch (Zone.current[_kOptionsKey]) {
final LogOptions options => options,
_ => null,
};

/// {@nodoc}
/// Internal mixin for [InnerLogger] to run in [Zone]
@internal
base mixin InnerZonedMixin on InnerLogger {
@override
R capture<R extends Object?>(R Function() body, [LogOptions? logOptions]) =>
Expand Down
2 changes: 0 additions & 2 deletions lib/src/log_level.dart
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ sealed class LogLevel {
@literal
const factory LogLevel.vvvvvv() = _LogLevelRegular6;

/// {@nodoc}
const LogLevel._({
required this.prefix,
required this.level,
Expand All @@ -58,7 +57,6 @@ sealed class LogLevel {
factory LogLevel.fromValue(Object? value) =>
_table[value] ?? const LogLevel.info();

/// {@nodoc}
static final Map<Object, LogLevel> _table = <Object, LogLevel>{
for (final e in values) e.level: e,
for (final e in values) e.prefix: e,
Expand Down

0 comments on commit ac2e5a5

Please sign in to comment.